This is an old revision of the document!
Scene files contain information about one or many scenes, and have a deep hierarchy. At the top level, a scene file has the following keys:
- _myCurrentFilename: This key is used to internally track which file is loaded in the engine.
- nameOfScene: All other top-level keys are the names of Scenes stored in this file.
Within each Scene key, there are the following keys:
- Entries: The number of Moments in this scene
- endAction: The name of the scene to continue on to after this one (unless redirected by choices)
- <number>: One or more numbers corresponding to the Moments in a scene
Each numbered Moment in a Scene key all of the major categories of information for the Engine are stored. These include:
- sound: Sound to play during this moment.
- background: Image to show in the background during the moment.
- timer: Amount of time to display the moment before moving to the next moment.
- textbox: The data for all textboxes in this specific moment.
- characters: The data for all characters in this specific moment.
- choices: The data for all choices presenting in this specific moment.
General format:
{ "_myCurrentFilename": "sludge.txt", "sceneName": { "Entries": "0", "endAction": "sceneName2", "0": { "sound": "", "background": "", "timer": "-1", "textbox": { "0": { "typed": "1", "label": "[r:markedName]", "animate": 1.000000, "text": "Sample text", "avi": "", "x": "542", "style": "", "y": "588" } }, "choices": { "0": { "pin": 1.000000, "link": "", "ripple": "0", "normal": { "label": "", "avi": "", "style": "Default" }, "command": "", "hover": { "label": "", "avi": "", "style": "Default_hover" }, "text": "Choice Text", "sprite": "", "x": "617", "condition": "", "y": "204.20" } }, "characters": { "0": { "moveSpd": "-1", "flipped": "0", "fadeSpd": "-1", "marked": "0", "scale": "0.41", "x": 256.000000, "rotSpd": "-1", "darkened": "0", "ID": "0", "y": 506.880000, "expression": "" } } } } }