autopilot README

The project's README from github.com/ramenvr/autopilot. As one markdown file: README.md.

Aura Autopilot

By the developers of Aura, www.tryaura.dev

Aura by Ramen

Autopilot is a continually learning real-time general playtesting system. It supports Unreal Engine 5, Unity 6, and Godot 4 on both Windows and MacOS.

Install Autopilot into your project and let it learn your game, explore your levels, and improve its gameplay run after run.

Installation

You can find the installation instructions in the Autopilot docs

Installing pre-built packages

  1. Download the latest Autopilot build for your game engine and OS from https://www.tryaura.dev/autopilot/.

  2. Install Autopilot into your project.

    Unreal (v5.4-5.8)

    1. Unzip the download. Move Autopilot/ into your project's Plugins/ folder (create a Plugins/ folder yourself if your project doesn't have one yet). You should therefore have <YourProject>/Plugins/Autopilot/Autopilot.uplugin.
    2. Open your project. Click the orange Autopilot icon to open Autopilot.

    Unity (v6 or later)

    1. Unzip the download. It should contain the file com.ramenvr.autopilot-<version>.tgz.
    2. Open your project. In Window > Package Management > Package Manager, choose + > Install package from tarball..., and pick that file.
    3. Open Window > Autopilot.

    Godot (v4.7 or later)

    1. Unzip the download. Move autopilot/ into your project's addons/ folder.
    2. Open your project. Enable Autopilot in Project > Project Settings > Plugins. The Autopilot dock appears on the right.

  3. Follow the Autopilot setup flow.

    1. We recommend using Autopilot with your Aura account. Click Create Account if you don't yet have an Aura account, or Sign in if you are a returning user.
    2. Autopilot runs its setup, and finally redirects you to the signup/signin page. Complete your signin/signup process.
    3. Upon successful authentication, you should see the "Agent service ready" page. Click Continue.
    4. You have the option to enable/disable sharing your runs to improve Autopilot. As the developers of Autopilot, we would of course appreciate your enabling this!
    5. (Optional) Run the 10-minute exploration run to populate your Autopilot project memory. It is safe to skip this and jump straight to sending your own prompt.
    6. Prompt Autopilot! See the types of prompts you can try in Usage.

Installing from source

You can install Autopilot from source. This is supported for Unreal Engine only. This method allows you to build Autopilot against an Unreal source build, and places the Autopilot plugin into your Unreal project's Plugins folder automatically.

git clone https://github.com/ramenvr/autopilot.git
cd autopilot
powershell -ExecutionPolicy Bypass -File tools\build_unreal.ps1 `
  -EngineDir "C:\path\to\UnrealEngine" `
  -PluginsDir "C:\path\to\YourProject\Plugins"

Once that has completed, follow the Autopilot setup flow as shown in Step 3 of Installing pre-built packages.

Usage

The main way to use Autopilot is through the Autopilot plugin in your editor. This works in Unreal Engine 5, Unity 6, and Godot 4 on both Windows and MacOS. This path uses your Aura plan, or your BYOK API keys.

Alternative ways to use Autopilot include:

An Autopilot prompt is one of 4 types:

For every prompt, Autopilot will automatically launch a PIE window and start reading your project's source code, probe PIE, and start playing according to your prompt. Autopilot plays by using an LLM coding agent to craft harnesses for a decision model according to what it knows about your game, and requests decisions (action choices) from the decision model during gameplay. Once Autopilot is done, the PIE window will close automatically, and Autopilot generates a report for you.

Your first few runs allow Autopilot to learn about your game as it gradually populates its memory. Expect some suboptimal behavior for the first few harness attempts. Autopilot visibly improves the more it plays your game, and later harness attempts and runs both take a shorter time to complete a given task, as well as exhibit more intelligent behavior (e.g. faster dodging, equipping better weapons, playing smarter strategies, better aiming).

Uninstallation

  1. In Autopilot, go to Settings and click Uninstall. By default, Autopilot keeps your project's memories; you can choose to delete memories instead (this is a destructive action).
  2. Remove the plugin from each project: Unreal, close the editor and delete Plugins/Autopilot/; Unity, remove the Autopilot package in the Package Manager; Godot, disable Autopilot in Project > Project Settings > Plugins, then delete addons/autopilot/.

Contributing

Contributions are welcome. CONTRIBUTING.md explains how to set up a development environment, run the tests, and add support for a new engine. Please follow the Code of Conduct.

License

Apache License 2.0. The plugins bundle fonts under the SIL Open Font License; see each font's OFL file.

autopilot (ramenvr/autopilot)

Searching Database…