Player Preferences

Player preferences are settings that players can adjust during gameplay through the settings screen. These values are saved to storage and persist between sessions.

Setting Default Preferences#

Set default preferences in your options.js:

monogatari.preferences({
    'Language': 'English',
    'Volume': {
        'Music': 1,
        'Voice': 1,
        'Sound': 1,
        'Video': 1
    },
    'TextSpeed': 20,
    'AutoPlaySpeed': 5
});

All Preferences#

Accessing Preferences#

Get a Preference#

// Get current language
const language = monogatari.preference('Language');

// Get music volume
const musicVol = monogatari.preference('Volume').Music;

Set a Preference#

// Set language
monogatari.preference('Language', 'Español');

// Set text speed
monogatari.preference('TextSpeed', 30);

// Set volume
monogatari.preference('Volume', {
    'Music': 0.8,
    'Voice': 1,
    'Sound': 0.5,
    'Video': 1
});

Volume Settings#

Volume values range from 0.0 (muted) to 1.0 (full volume):

monogatari.preferences({
    'Volume': {
        'Music': 0.7,    // 70% volume
        'Voice': 1.0,    // 100% volume
        'Sound': 0.5,    // 50% volume
        'Video': 0.8     // 80% volume
    }
});

Volume Categories#

Text Speed#

The TextSpeed preference controls how fast the typewriter animation displays text. Lower values mean faster text:

monogatari.preferences({
    'TextSpeed': 20  // Default speed
});

Auto-Play Speed#

The AutoPlaySpeed preference controls how long the game waits after text is fully displayed before automatically advancing:

monogatari.preferences({
    'AutoPlaySpeed': 5  // 5 seconds
});

Language Preference#

For multi-language games, this determines which script version is used:

monogatari.preferences({
    'Language': 'Español'
});

See Internationalization for multi-language setup.

Resolution (Electron)#

For desktop builds using Electron, this sets the window resolution:

monogatari.preferences({
    'Resolution': '1280x720'
});

Settings Screen#

Players can adjust these preferences through the built-in settings screen:

• Audio sliders - Adjust Music, Voice, and Sound volumes
• Text Speed slider - Adjust typewriter animation speed
• Auto Play Speed slider - Adjust auto-advance timing
• Language dropdown - Select UI/game language (if multi-language enabled)
• Resolution dropdown - Select window size (Electron only)

Programmatic Updates#

You can update preferences based on game events:

// In your script, use a function
monogatari.script({
    'Start': [
        // Player chooses "quiet mode"
        function() {
            monogatari.preference('Volume', {
                'Music': 0.3,
                'Sound': 0.3,
                'Voice': 1,
                'Video': 0.5
            });
            return true;
        },
        'The audio has been adjusted for quiet mode.',
        'end'
    ]
});

Persistence#

Preferences are automatically:

• Saved to storage when changed
• Loaded when the game starts
• Synced with the settings screen UI

Related#

• Game Configuration - Engine settings
• Internationalization - Multi-language setup
• Saving - Save system configuration