Installation
Import Settings Kit, try the demo, and find what it adds to your project.
Requirements
Settings Kit supports Unity 6.0 and newer, on every platform Unity builds for.
Install the package
To add Settings Kit to your project:
- Go to Window > Package Manager.
- Select the My Assets tab, then select Settings Kit.
- Select Download, then select Import.
Unity imports the package into Assets/Settings Kit. You can move that folder anywhere under
Assets. To declare your first page, refer to Get started.
Run the demo
The Demo folder uses every feature in a working example: build, per-platform, editor and user
settings, validation, migration, a custom drawer, an asset reference, and a runtime reader.
It adds a Settings Kit Demo page to Project Settings and to Preferences, and a Tools > Settings Kit > Demo menu that logs the current values and opens the pages.
Warning: Delete the
Demo folder before you ship. Its build settings are included in every build made with the folder in the project.Package contents
| Folder | Contents |
|---|---|
Runtime | The SettingsKit assembly: everything your code uses. |
Editor | The settings windows and the build step. |
Demo | The demo. Safe to delete. |
Documentation | These pages. |
Tests | The package's own tests. Safe to delete. |
Tools menu reference
Settings Kit adds the following entries under Tools > Settings Kit.
| Menu item | Description |
|---|---|
| Documentation / Public API | Opens these pages offline, from the package folder. |
| Demo | Logs the demo's current values, or opens its pages. Gone once you delete the Demo folder. |