Game settings control how your visual novel behaves. These settings are typically defined in your options.js file using monogatari.settings().
Setting Values
// Set multiple settings at once
monogatari.settings({
'Name': 'My Awesome VN',
'Version': '1.0.0',
'AutoSave': 5
});
// Get a specific setting
const gameName = monogatari.setting('Name');
// Set a single setting
monogatari.setting('AutoSave', 10);All Settings
| Setting | Type | Default | Description |
|---|---|---|---|
Name |
string |
'My Visual Novel' |
Game name used for storage. Don’t change after release. |
Version |
string |
'0.1.0' |
Game version in semantic versioning. |
Label |
string |
'Start' |
Initial label where the game begins. |
Slots |
number |
10 |
Number of save slots available. |
MultiLanguage |
boolean |
false |
Enable multi-language support. |
LanguageSelectionScreen |
boolean |
true |
Show language selection before loading. |
MainScreenMusic |
string |
'' |
Music asset ID to play on main menu. |
SaveLabel |
string |
'Save' |
Prefix for save slot storage keys. |
AutoSaveLabel |
string |
'AutoSave' |
Prefix for auto-save slot storage keys. |
ShowMainScreen |
boolean |
true |
Show main menu on game start. |
Preload |
boolean |
true |
Enable asset preloading on web. |
AutoSave |
number |
0 |
Auto-save interval in minutes (0 = off). |
ServiceWorkers |
boolean |
true |
Enable service workers for caching. |
AspectRatio |
string |
'16:9' |
Aspect ratio for backgrounds. |
ForceAspectRatio |
string |
'None' |
Force aspect ratio: 'None', 'Visuals', or 'Global'. |
TypeAnimation |
boolean |
true |
Enable typewriter text animation. |
NVLTypeAnimation |
boolean |
true |
Enable typewriter animation in NVL mode. |
NarratorTypeAnimation |
boolean |
true |
Enable typewriter animation for narrator. |
CenteredTypeAnimation |
boolean |
true |
Enable typewriter animation for centered text. |
Orientation |
string |
'any' |
Mobile orientation: 'any', 'portrait', or 'landscape'. |
Skip |
number |
0 |
Skip speed in ms (0 = disabled). |
SplashScreenLabel |
string |
'_SplashScreen' |
Label for splash screen (if exists). |
AllowRollback |
boolean |
true |
Allow players to go back in the game. |
ExperimentalFeatures |
boolean |
false |
Enable experimental/unstable features. |
Assets Path
The AssetsPath setting controls where assets are loaded from:
monogatari.settings({
'AssetsPath': {
'root': 'assets',
'characters': 'characters',
'icons': 'icons',
'images': 'images',
'music': 'music',
'scenes': 'scenes',
'sounds': 'sounds',
'ui': 'ui',
'videos': 'videos',
'voices': 'voices',
'gallery': 'gallery'
}
});Storage Configuration
Control how game data is stored:
monogatari.settings({
'Storage': {
'Adapter': 'LocalStorage', // LocalStorage, SessionStorage, IndexedDB, or RemoteStorage
'Store': 'GameData', // Storage key/database name
'Endpoint': '' // URL for RemoteStorage adapter
}
});Storage Adapters
| Adapter | Description |
|---|---|
LocalStorage |
Default. Persists in browser storage. |
SessionStorage |
Cleared when page is closed. |
IndexedDB |
Uses IndexedDB web API. |
RemoteStorage |
Sends data to a REST API endpoint. |
Detailed Documentation
- Asset Preloading - Preloading and caching settings
- Internationalization - Multi-language game setup
- Saving - Save slots and auto-save configuration
- Skip Main Menu - Starting directly into the game
Related
- Player Preferences - Player-adjustable settings
- Split Files - Organizing scripts across multiple files