Set up save game related settings and the save game UI.
The save game settings are found in Menus > Save Game Settings.
Saving the player’s progress is mandatory for most games. ORK Framework includes a complete save game system that will save and load game data. Save games can either be saved actively by the player selecting a save game file, or by using Auto Save Slots to automatically save the progress to a previously selected slot.
The save game system can be expanded to save custom data (e.g. from 3rd party products) with the regular save data by adding Custom Save Data. or Custom Component Save Data.
Base Settings #
Define the number of save slots and auto save slots.
Save File Settings #
Define where save games are saved and if the data should be encrypted.
Depending on the game engine you’ll have different save locations available.
Screen Fade Settings #
Optionally override the default screen fade settings for load game scene changes.
Save Data Settings #
Define which game data will be saved.
Game Data #
Save general game data, e.g. game time, volumes (when not saved as a separate options file), faction standings, logs, quests, etc.
Player Group #
Save player group data, e.g. if the player is saved, current positions, etc.
Inventory Data #
Save inventory data of the player, e.g. items, equipment, crafting recipes, etc.
Scene Data #
Save data of different game scenes, e.g. content of item boxes and shops, state of item collection/drops, battles or spawned combatants.
Additionally, scene data can be auto removed after a number of scene changes, e.g. resetting state of a scene’s battles after the player changed the scene 3 times (without returning to the scene).
Variable Data #
Save variable data – either save all and exclude defined variables or only save defined variables.
File Settings #
Define save file content information.
Save File Name #
Define the name used for save files. Can include the index of the save file.
This’ll be used in other content setups to represent the save file.
File Info #
The text displayed for saved save game files.
Can include different content information, e.g. game time, save time, number of saves, player name, etc.
Empty File Info #
The text displayed for empty save game files.
Delete File Settings #
Optionally allow the player to delete save files using an input key.
Auto Save Settings #
The game can be automatically saved by using the Auto Save schematic node or a Save Point component using the Auto Save type.
Auto File Name #
The save file name used for auto save files.
Auto Save Message #
Optionally display a notification after an auto save happened.
Automatically closes after a defined amount of time.
UI Backgrounds #
Define backgrounds what will be displayed while save game menus are displayed.
The save game menu, load game menu and save point menu can override these backgrounds with a different setup.
Pause Settings #
Define if the game is paused while save game menus are displayed.
Save Game Menu #
Set up the save game menu used to select a save file and save the game.
Save Question Dialogue #
Optionally display a question dialogue if the player really want’s to save to the selected save game file.
Saving Info Dialogue #
Optionally display an information dialogue while saving the game.
Saved Info Dialogue #
Optionally display an information dialogue after saving the game.
Load Game Menu #
Set up the load game menu used to select a save file and load the game.
Load Question Dialogue #
Optionally display a question dialogue if the player really want’s to load the selected save game file.
Loading Info Dialogue #
Optionally display an information dialogue while loading the game.
Loaded Info Dialogue #
Optionally display an information dialogue after loading the game.
Save Point Settings #
Optionally use a choice dialogue (save, load, cancel) when using save points, either using a Save Point component or a schematic with a Save Game Menu node using Save Point menu type.
When not using a choice dialogue, using a save point will only display the save game menu.
Adding Custom Save Data #
You can add custom save data via scripting.
Custom Save Data #
Add custom save data (e.g. 3rd party product data) to save games by registering a class (e.g. a component) to the save game system. The class must implement the ISaveData interface.
Learn more about custom save data in this documentation.
Custom Component Save Data #
Store component data attached to a combatant’s object and save it with ORK’s save game system.
This is done by implementing the IComponentSaveData interface in your component’s class.
Learn more about custom component save data in this documentation.

