RyuoDocs

Your first project

Create or open an Unreal project and connect the editor.

Create or open a project

  • New project → On this computer creates a blank C++ game using your installed Unreal 5.8.
  • In the cloud creates a blank C++ project without a local engine. Ask the agent to start a cloud editor when ready; creating the project starts no paid session. Your project files stay on your computer and cloud editor changes sync back when the session stops.
  • To use a game you already have, open its .uproject file from the title bar.

What setup changes in your project

Opening a project runs setup once. It:

  • copies Ryuo's editor plugin, RyuoBridge, into the project's Plugins folder;
  • turns on the Unreal plugins Ryuo talks to (Remote Control, Unreal MCP and Pixel Streaming, among others);
  • writes the project settings they need;
  • builds the project if the editor is closed.

Running setup again changes nothing that's already correct. Your own code and assets are not touched.

On Mac, C++ compilation automatically saves, rebuilds and reopens the local editor. Windows cloud editors retain Live Coding. Ask for a Mac package to build an Apple Silicon game locally with Unreal and Xcode; stop and sync any cloud session first. Windows cloud packaging produces Windows games. Distribution signing and notarization of your game are separate.

Connect the editor

The workspace has Assets, Sessions and Agent panels around the viewport. Use their buttons in the bottom bar to show or hide them, or right-click a button to move its panel. The Sessions history icon starts on the right. If you've already arranged your panels, your saved layout stays in place. For playtesting, ask the agent in chat or use Unreal's Play controls.

Ryuo starts the editor in the background when you open a project, so it's compiled and ready before your first chapter. You can turn that off with Open Unreal with the project in Settings → Workspace. If the editor isn't running, click Launch Unreal to start it. Live editor, beside the project selector, turns green when connected and red when disconnected. With the game view layout, open Live preview to see and control the editor inside Ryuo.

If launch reports that setup is unfinished, open Settings → Advanced → Setup details to see the remaining step. The compiled plugin must show Up to date before launch. On Mac, setup recognizes and reuses an up-to-date Mac build; no Windows build is needed.

Ryuo only drives the editor that belongs to the project you have open. If another project's editor is running, close it or open that project in Ryuo instead.

Before launching, Ryuo checks whether another process is using Unreal's connection ports. A conflict names the port and process ID; Ryuo does not stop that process. Close the conflicting service yourself before trying again. On Mac, a short Waiting for editor ports stage can also appear after a restart while macOS releases old connections.

If compilation succeeds but the editor cannot reconnect, treat that as a connection problem, not another compiler error. Keep Unreal open to preserve unsaved work and expand the failed tool's details for the recovery instructions. Repeated rebuilds will not fix an occupied port.

If Unreal is frozen and won't close, ask Ryuo to force quit this project's editor. Ryuo shows the project and editor processes it will stop and always asks for your confirmation, even in Auto mode. Unsaved work is lost, and an asset being written may be damaged. Force quit works on Mac and Windows without an editor connection and never stops another project's editor. It doesn't rebuild or reopen Unreal, so ask Ryuo to rebuild afterwards. It isn't available during a cloud editor session, and a connection error alone is not a reason to use it.

After Ryuo updates

A new version of Ryuo can come with a new version of its editor plugin. Ask the agent to rebuild the editor, or rebuild it yourself, so the project picks it up.

Make the studio yours

Open Settings → Workspace to see a preview of your layout and choose a color palette. Each theme shows a small workspace and its colors. Customize studio reopens the guided setup. Pick a layout there: Chat shrinks the studio to a narrow window with the chat beside chapters and generations, and Unreal stays in its own window; Chat + game view adds the Ryuo orb and a live view of Unreal. Take the tour replays the quick walkthrough, starting directly at your workspace controls without a welcome screen.

Creation holds image models and per-task limits. Advanced holds computer setup and troubleshooting. Developer-only connection settings stay hidden until Show developer tools is clicked in a development build.

Click your account name to open Analytics, with your available and beta credit balances, daily activity, active days and credits used in the last 30 days, plus a breakdown of your work over the last year. Details holds your plan and account actions. Counts may take a minute to arrive. Local assistant subscription usage remains with that provider.

If the sign-in browser tab was closed, use Reopen sign-in in Account settings to open a fresh approval page with the code already filled in.

Start working sooner

On your first launch, Open my project opens a project in the Chat layout without automatically starting Unreal. Start a game opens project creation with the game view. You can personalize later in Settings. A note from Ryu remains available on Home.

New projects suggest a Ryuo Projects folder in your home directory, outside the usual OneDrive Documents folder. Your chosen location is remembered. Existing projects stay where they are.

Use Focus chat for a wider conversation and Show game view to return. In Settings → Advanced, project readiness separates installation, integration, editor startup and connection; expand Setup details for diagnostics.

Follow a chapter

Choose a path in Chapters and click Start step. A short guide explains how to reply, handle permission requests and review the result. Chapter instructions appear as a compact Chapter step row in chat; click it to read the full instructions. Ryuo still receives everything it needs.

Answer questions in the message box and describe changes you want. When a step is ready, Ready for your review appears above the chat box. Read its verification evidence, try the result, and choose Accept result when you are happy. You can also accept from the chapter details. If several steps are ready, each result names its chapter and step. Acceptance becomes available after verification and once the agent finishes. Then start the next step.

Changing paths keeps each path’s progress separately. Switching back restores it; changed step requirements need a fresh review. Your game files stay in place, so review the game plan when starting a different path. Finish or cancel active work before switching.

The orb and current chapter follow the step you started. Steps waiting behind another task show Queued and become current when their instructions enter the conversation.

You can queue another chapter while Ryuo works. Each chapter runs in its own turn. Removing a queued step leaves its progress unchanged. Repeated clicks do not submit the same step again.

Later chapters show their recommended prerequisites. If your existing project already has what they need, open the chapter and choose Start early. Otherwise, follow the suggested order.

After accepting a result in either view, chat offers Start next step with its name. Nothing starts or spends credits until you click it.

Reset progress clears only that step’s status and verification evidence after confirmation. It does not undo edits or delete game assets. Finish or remove queued work first.

Chapter screenshots belong to the current project and path. Switching projects clears the old previews.

Chapters shows a map of the recommended order. Choose Expand for a larger view or Change to choose another path, such as Vehicle. Cards show each chapter’s status, and map animations respect your system’s reduced-motion preference.

Verification details load when you expand a record. If loading fails, use Retry evidence; acceptance still checks the saved verification against your current project.

On this page