Unity
Set up Unity, make a new Unity game or bring one you have, and what Ryuo adds to it.
Ryuo works with Unity 6 projects, in C#. Ryuo is tested most with Unity 6.3 LTS and also works with Unity 6.6; choose 6.3 LTS when you can.
Set up Unity
Open Engines & setup in the left sidebar and choose the Unity card. Ryuo checks:
- Unity 6: a Unity 6 editor installed with Unity Hub. If Unity's command line tool is installed, Install Unity 6000.3 LTS installs the newest Unity 6.3 LTS release for you, with Web and Windows build support. It is a download of several GB; the progress shows under the row, and Cancel stops the download. Before it starts, Ryuo shows a link to the Unity Editor Software Terms: choosing Accept and install agrees to them, and Ryuo accepts them and the build support licence agreements on your behalf for that install. Without the command line tool, Open Unity Hub opens Hub, or Unity's download page if Hub isn't installed yet.
- Unity command line tool: Unity's
unitycommand, which Ryuo uses to create and open Unity projects. If you installed it somewhere Ryuo doesn't look, choose it in Settings → Advanced → Tool paths → Unity CLI executable. - Unity licence: sign in to Unity Hub and activate a licence. Unity Personal is free. Ryuo only reads whether a licence is active; it never asks for your Unity sign-in.
- Build support: the platforms your newest Unity 6 editor can build for. Add platforms in Unity Hub under Installs.
- Blender is optional, for modeling and game-ready meshes.
- Godot 4.7.2 is offered when your computer has no Godot 4.5 or newer. It is included in setup by default and installed after the Unity items; choose Don't install to leave it out.
You can switch between Unreal, Godot and Unity at the top of the setup window at any time.
Make a new Unity game
Choose + beside Games, then Create from scratch, pick Unity and choose 2D or 3D. If you have more than one Unity 6 editor, pick the version; 6.3 LTS is marked as recommended. Unity makes the project from its own Universal Render Pipeline 2D or 3D template, which takes a minute or two; the progress shows at the bottom of the window, and Stop creating stops it and removes the unfinished project. Ryuo then adds its package, a .gitignore for Unity's generated folders and Ryuo's own files, and opens the game in Unity. Opening a new project for the first time takes another minute while Unity imports it.
Bring a Unity game you have
Choose + beside Games, then Browse folder, and pick the project folder (the one with Assets, Packages and ProjectSettings). Ryuo shows the game it found, with its engine, before you choose Open game. The game appears under Games with the Unity logo. Ryuo opens it with the Unity version named in the project; install that version with Unity Hub if it's missing.
What setup changes in your project
Ryuo runs setup each time you open the game or launch Unity. It:
- copies Ryuo's package into
Packages/com.ryuo.bridge, so the project carries it for everyone who opens it; - adds Unity's Pipeline package to
Packages/manifest.json, which lets Ryuo work in the open editor; - turns on the Input System if the project only uses the old Input Manager, setting Active Input Handling to Both so your existing input code keeps working. Ryuo needs the Input System to press keys while it play-tests. Unity applies this the next time it opens the project, so Ryuo only changes it while Unity is closed.
Unity notices the new package while it is open and imports it. Running setup again changes nothing that's already correct, and your own scenes, scripts and assets are not touched. Settings → Advanced → Setup details shows each step.
If Unity opens in Safe Mode
Unity opens a project whose scripts don't compile in Safe Mode, where Ryuo can't reach it. Fix the errors Unity lists, then close and reopen the project.
Work in Unity from Ryuo
Opening or creating a game only sets it up; Unity starts when you choose Launch Unity in the Unity tab, or when the agent needs it while it's closed, in which case the agent opens it for you. Unity takes a minute or two to open a project the first time. It then opens inside Ryuo, in the Unity tab, the same way Unreal does (on a Mac, Ryuo needs Accessibility access to move Unity's window), and Live editor in the status bar turns green once Ryuo is connected. A new game opens on its first scene. A Unity you opened yourself from Unity Hub is found and docked too. Drag a creation from Generations onto the Unity tab to put it in the scene where you drop it on the Scene view: a model, sprite or sound is placed at that point, and a material goes on the object under it. Closing Ryuo saves your scenes in Unity and closes it, unless you turn off Linked; if a scene can't be saved, Ryuo asks before closing Unity.
While Unity is connected, the agent can:
- write C# scripts, have Unity compile them and fix the errors it reports by file, line and column;
- capture the Scene view, the Game view, or individual editor panels such as Inspector and Console;
- record performance captures and memory snapshots from the editor or a connected development build when investigating performance problems;
- play the game in Play Mode: it holds keys for real frames, takes screenshots and reads the game's log and errors;
- run small C# snippets in the editor or in the running game;
- bring generated and free images, models, sounds, sprites, materials and videos into
Assets/Ryuo/, and check what Unity imported; a model also gets a prefab next to it with colliders (convex ones unless you ask for none or exact ones), which is what goes in the scene; - turn a generated 3D model (rigged and animated by Tripo) or a rigged GLB or FBX of your own into a character prefab: a CharacterController with an Animator playing its idle animation and a ragdoll it can switch to;
- make that character the player in your first scene: walking and running with the WASD or arrow keys and Shift (or a gamepad), jumping with Space, the main camera following it and animations that match the movement, without changing the character prefab;
- restart Unity when it needs to, and force quit it if it freezes, after asking you.
Pressing Play while the game is already in Play Mode and nothing changed keeps it running instead of restarting it, and the agent's play-tests use it too. Once the project changes (the agent edits a script, a scene or an asset, or Unity imports a file you changed outside it), Play Mode ends, so the next Play shows the change.
If your scripts don't compile when Unity opens, Unity starts in Safe Mode, where Ryuo can't connect. Ryuo shows the errors; fix them (or ask the agent to), then let Ryuo restart Unity. On a Mac the agent can see the Scene view with its controls and gizmos, and capture individual editor panels, but can't click through Unity's own windows yet. Performance recordings and memory snapshots are saved as files for inspection in Unity's profiling tools. Characters are imported as Generic rigs, not Humanoid, and advanced rigging (moves filmed by a video model) is only available in Unreal. Unity can't run in the cloud.