Installation and Updates
Atlas runs inside the Unity Editor. Install it into the project containing the Opsive product you want help with.
Requirements
| Requirement | Supported starting point |
|---|---|
| Unity | Unity 2022.3 or newer |
| Behavior Designer | Behavior Designer Pro 3.3.0 or newer |
| State Designer | State Designer 1.3.0 or newer |
| Character Controller | Ultimate Character Controller 3.3.7 or newer within Version 3 |
| Local Codex | Windows or macOS, with the Codex app or standalone CLI and an eligible signed-in account |
| Connection | Internet access to Opsive and the selected model provider |
Classic Behavior Designer and Character Controller Version 4 are not interchangeable with the product versions described in this manual. The optional Unity native-tool integration requires Unity 6 or newer; ordinary Atlas use does not.
Install Atlas
- Install or update the supported Opsive product and let Unity finish importing it.
- Download Atlas from the Atlas product page. Use that page for the standalone download rather than the general Opsive Downloads page.
- Import the package into the same Unity project and wait for compilation to finish.
- Open Atlas from your installed Opsive product using the menu listed below.
- Complete account connection and provider setup.
Use the menu for the product you want help with:
| Product | Menu |
|---|---|
| Behavior Designer Pro | Tools > Opsive > Behavior Designer > Atlas |
| State Designer | Tools > Opsive > State Designer > Atlas |
| Ultimate Character Controller | Tools > Opsive > Ultimate Character Controller > Atlas |
Behavior Designer Pro and State Designer can also host Atlas as a docked panel. A product panel supplies its product context automatically.
Update an existing installation
Commit or back up the project, let active Atlas requests finish, and import the newer Atlas package. If an update is advertised in the window, open Settings > Download Atlas update…. The item is disabled when no update is offered.
Avoid keeping two imported copies of Atlas under different folders. Duplicate assemblies or types can prevent compilation and make menu items disappear. After updating, wait for compilation, reopen Atlas, and check the active product and provider.
Atlas keeps project-local chat state across ordinary window closures and assembly reloads. That state is not a substitute for saving generated source or plans. See The Atlas window.
If a menu is missing, check the Unity Console and resolve any compilation errors. If the Atlas panel still shows Download Atlas after importing, restart Unity and reopen the panel. If the prompt remains with no Console errors, contact support with your Opsive product version, the Atlas package filename, and screenshots of the imported Atlas files and Console. See Troubleshooting.