Server-Side Logic
Rune uses a server-authoritative approach to ensure games run smoothly and prevent cheating. To do this, your game's logic.js
file will run on every client and on Rune's servers (see Syncing Game State for more details). Rune ensures that all players see the same thing when playing your game by having some limitations on what kind of code you can write in your logic.js
file.
The primary aim is to ensure that the code is deterministic, meaning that if you run the code multiple times with the same input it will produce the same result. The main contributors to non-deterministic code in this context is use of other non-deterministic functions such as Date.now()
and access of shared state such as counters and cache variables.
The Rune SDK will help check your code for unsafe patterns such as:
- Mutation and assignment of variables outside of current function scope
async
/await
syntax as logic must be synchronoustry
/catch
syntax as this can interfere with (throwing is still allowed)eval
because it's potentially harmful and can be used to bypass other rulesthis
keyword as it allows classes to have hidden side effects- Non-deterministic runtime built-ins such as
Date
andfetch
- Regular expressions because they are stateful
A notable exception to this list is Math.random()
which Rune makes deterministic (see Randomness for more info).
The Rune CLI will also warn you if it detects that your game logic seems to be using potentially unsafe code when uploading. Don't worry, we'll also help ensure that your game runs smoothly across devices when testing it before it's released.
Why this approach using deterministic code?
Because it's the future! 😎 All modern multiplayer engines use predict-rollback netcode with deterministic physics. For instance, Rocket League and Mortal Combat both use this approach. It's how you make great multiplayer games that work even in bad network conditions.
Rune's predict-rollback approach is extremely bandwidth-efficient as only the action payloads are sent between clients and server, not the entire game state. Clients can also simulate the world ahead of the server, which makes real-time games possible even on bad mobile internet with frequent latency spikes. This is all done by having the exact same deterministic game logic running on both the clients and the server.
External Dependencies
You can import external dependencies in your game logic, e.g. for physics or pathfinding. Many external libraries contain code that have unintended side effects and thus does not comply with constraints listed above. For that reason Rune has a list of known supported libraries.
In case you use a library that's not on the supported libraries list, you'll receive a warning in CLI during development. If you build the game and successfully upload it to Rune, we would appreciate if you add the dependencies to the list linked above.
Editor Integration
Rune has created an eslint plugin to give warnings for potentially unsafe code directly in your editor! If you're using the Rune quickstart template created using npx rune-games-cli@latest create
, then this eslint plugin is already set up for you. If not, then follow the steps below.
Add the plugin to your eslint.config.mjs
configuration file:
import runePlugin from "rune-sdk/eslint.js"
...
export default [
//other config
//...
...runePlugin.configs.recommended,
]
That's it. Your logic code will now be linted to detect potentially unsafe code and prevent desyncs! 🧙♂️
By default, the plugin will check files named logic.js
/logic.ts
or files in a logic
folder for the Rune SDK rules. If needed, you can specify more files to lint yourself with:
import runePlugin from "rune-sdk/eslint.js"
export default [
{
files: ["**/logic.ts", "**/logic.js"],
...runePlugin.configs.logicModuleConfig,
}
]
You can also check out the eslint plugin code.