Editor setup
The guided Setup page — three presets, eleven explanation sections, and a smoke test that proves the wiring.
Where a new project starts#
NexusForge → Persistence → Setup. The page has three parts, in the order you need them.
1. Choose a starting point#
| Preset | What it turns on |
|---|---|
| Minimal | Local storage with integrity and one retained backup. Autosave, encryption and cloud off. |
| Recommended | The above plus autosave, checkpoints and Deflate compression. |
| Hardened | The above plus AES-256-CBC/HMAC encryption and HMAC-SHA256 integrity — and it warns up front that the game must supply an ISaveKeyProvider at runtime. |
Each preset shows what it will set, in plain language, before it is applied.
2. Understand what you configured#
Eleven sections (General, Local storage, Serialization, Versioning, Autosave, Checkpoints, Security, Cloud, Conflict resolution, Limits, Platform). Each asks a question, explains what the choice costs, and names what to look for afterwards. Nothing is hidden behind a wizard: every value it sets is an ordinary field on the All settings page, editable afterwards.
3. Review and check#
A summary of what is configured, the smoke test, validation, and the code to paste.
Run smoke test -> writes and reads a small model through the real pipeline
reports bytes written, the path used, and how long it tookWhat the Editor will not do#
- It will not change your Player Settings, scripting backend or scenes.
- It will not create folders, keys, accounts or service credentials.
- It will not bypass a validator, a migration, an integrity check or the concurrency coordinator to make configuration easier.
Next#
- Configuration — the All settings page.
- Validation — the two depths, and what each one checks.
- Configuration reference — every setting with its cost.
Something wrong on this page? Every page here describes behaviour that is checked in the repository. If a page and the package disagree, the package wins.
Report a documentation problem · Frequently asked questions · Troubleshooting