Installation
Requirements
| Requirement | Detail |
|---|---|
| Unity | 6000.0 to 6000.7, at least 6000.0.85f2 |
| Project template | Universal 3D (URP) |
| System | Windows |
These are optional:
- Bakery, sold separately. It needs an NVIDIA GPU. RAPTOR bakes with Bakery when it is installed, and with Unity's lightmapper otherwise.
- Unity 6000.3 or newer, for the Ray-traced preview.
Installing
Create a project
In Unity Hub, create a project from the Universal 3D template with a supported Unity version, and open it.
Import RAPTOR
Open Window → Package Manager (from Unity 6.1: Window → Package Management → Package Manager) and choose My Assets. Select RAPTOR, press Download, then Import.
RAPTOR is imported into Assets/RAPTOR.
Open the editor
Choose Tools → RAPTOR → Open Editor in Unity's menu bar.
Choose where your data goes
The first time RAPTOR opens in a project, it shows Welcome to RAPTOR, with links to the Documentation and the Discord server (Join the Discord), then the Data folder.
- Continue uses the folder shown,
Assets/RAPTOR Databy default. - Choose picks another folder under
Assets.
Nothing else in RAPTOR's window works until you press Continue. RAPTOR saves your models, the Prototype pack and your Logic blueprints there. The folder cannot be changed once it holds data: a project that already has RAPTOR data shows it as Locked, and only Continue is needed.
RAPTOR then creates the Prototype material pack in the data folder.
If a package is missing
RAPTOR needs a few Unity packages. The Universal 3D template includes them all. From Unity 6000.6, it no longer includes Mathematics.
If one is missing, RAPTOR names it when the project opens and offers to show it in the Package Manager. RAPTOR loads once the package is installed. RAPTOR never installs packages itself.
Packages RAPTOR needs
| Package | Id | Version |
|---|---|---|
| Universal RP | com.unity.render-pipelines.universal | 17.0.3 or newer |
| Burst | com.unity.burst | Any |
| Collections | com.unity.collections | Any |
| Mathematics | com.unity.mathematics | Any |
Install these from Unity Registry in the Package Manager.
Built-in modules RAPTOR needs
Animation, Audio, Image Conversion, IMGUI, JSONSerialize, Particle System, Physics, Terrain, Terrain Physics and UIElements.
They are on by default in new projects. If one is off, turn it on from Built-in in the Package Manager.
The parts of RAPTOR that run in your game need only Audio, IMGUI, JSONSerialize, Particle System and Physics. If you remove another module, the RAPTOR editor turns off until you add it back, and your levels keep working in the game.
Where things go
RAPTOR keeps its own files separate from yours.
| Folder | Holds | When you update |
|---|---|---|
Assets/RAPTOR | RAPTOR itself, with its samples and offline documentation | The update replaces it. It holds none of your data |
Assets/RAPTOR Data | Everything you make with RAPTOR | Keep it |
ProjectSettings/RaptorSettings.asset | RAPTOR's settings for this project | The update keeps it |
Updating RAPTOR
Back up the project first, save your scenes, close RAPTOR's window and leave Play mode.
Update
Open Window → Package Manager and choose My Assets. Select RAPTOR, press Update, then Import.
Import every file
In the import window, leave every file ticked and press Import.
Open the editor
Wait for Unity to finish compiling, then choose Tools → RAPTOR → Open Editor.
Unity's import never deletes a file, so files an earlier version had and the new one does not stay in Assets/RAPTOR. After the update RAPTOR lists them and asks once: Move to trash or Keep them. To run it again later, use Tools → RAPTOR → Maintenance → Remove Old Files.
If red errors show after an update, open a new, empty scene, delete the Assets/RAPTOR folder (keep Assets/RAPTOR Data), and import RAPTOR again from My Assets.
Checking the setup
→ account menu → Settings → Modules
The Environment section shows what RAPTOR detected.
| Check | Should read |
|---|---|
| Unity | OK |
| URP package | OK |
| URP asset | OK |
| Ray tracing | OK, or Unsupported before Unity 6000.3 or without a ray-tracing GPU |
| Bakery | OK when installed, otherwise Missing |
For any other value, see Troubleshooting.
Samples
Two samples ship in Assets/RAPTOR/Samples:
LogicStarter: a small level built with Logic and no code. OpenLogicStarter.unityand press Play.ModuleTemplate: a minimal working module, for programmers. See Writing a module.
Next: Quick Start.