Settings

The engine provides two separate settings systems: Engine Settings shared across all games, and Game Settings specific to each game.

Both are shown to the player in the game menu and can be read/written from scripts.

Engine Settings

Engine-level settings are shared across all games and persisted to the browser's localStorage. They survive page refreshes, game restarts, and switching between games.

Built-in Settings

API

// Read
const volume = game.getEngineSetting('music_volume');
const speed = game.getEngineSetting('typing_speed');

// Write (auto-persisted to localStorage)
game.setEngineSetting('music_volume', 50);
game.setEngineSetting('typing_speed', 'none');

The player can also change these directly via Engine Settings in the game menu.

Game Settings

Game settings are specific to your game and persisted in save files. They are defined in the engine editor under General tab and shown inside Game Settings in the game menu (only visible when at least one setting is defined).

Defining Settings

Open the engine editor and navigate to Game Settings. Each entry has:

The title type creates a section header (not a setting) to organize the menu visually.

Localizing option labels

By default a chooseOne/chooseMany setting shows its raw option values in the menu (e.g. very_hard, fast). Set localizeValues: true to display human-readable labels instead.

Labels are looked up by the key convention <settingId>.<value>. For a setting difficulty with values easy/hard, add locale entries difficulty.easy, difficulty.hard:

Resolution order (first match wins):

1. Game locale (game.getLine) — your game's and plugins' merged locale. Use this for game-defined settings. Only consulted while a game is running.
2. Engine locale — built-in engine strings; used for engine-level settings.
3. Raw value — fallback when no locale entry exists, so a missing label degrades to the value rather than showing [difficulty.easy].

Because the lookup uses game.getLine, the same key works from scripts (e.g. game.getLine('difficulty.' + game.getGameSetting('difficulty')) to show the current difficulty's label in your own UI).

API

// Read
const difficulty = game.getGameSetting('difficulty');
const showHints = game.getGameSetting('show_hints');

// Write (persisted in save files)
game.setGameSetting('difficulty', 'hard');
game.setGameSetting('show_hints', false);

Example: Difficulty Setting

Define in the editor:

Use in scripts:

const diff = game.getGameSetting('difficulty');
const damageMultiplier = diff === 'hard' ? 1.5 : diff === 'easy' ? 0.5 : 1;

Example: Toggle Setting

if (game.getGameSetting('show_damage_numbers')) {
    // display floating damage text
}

Engine vs Game Settings