Ariko

A friendly AI assistant for Unity

---

Ariko is a friendly AI assistant for Unity game developers (with a user interface similar to GitHub Copilot). It can help you with everyday tasks like generating C# code, answering questions about your Unity project, and more.

Features

• Interactive Chat: A chat window where you can ask questions in natural language.
• Context Awareness: The assistant will know which asset, GameObject, or script you have selected to provide relevant help.
• Code Generation: Generate C# scripts, methods, or snippets based on your prompts.
• Project Awareness: Answer questions about your existing project.
• Unity API Helper: Explain how to use Unity components and functions with relevant examples.

See the ROADMAP.md file for the project roadmap.

Important

This project is in early development, so bugs and breaking changes are expected. Please use the issues page to report bugs or request features.

---

Installation

Ariko can be either installed from the OpenUPM registry or directly from the Git URL.

Note

Ariko is tested on Unity 2021.3, but should work on older versions of Unity too.

Install from OpenUPM

You can install Ariko using OpenUPM-cli by running the following command:

openupm add io.github.pixel-clover.ariko

Install from Git URL

1. In the Unity Editor, go to Window > Package Manager.
2. Click the + icon in the top-left corner of the Package Manager window and select "Add package from git URL...".
3. Paste the following URL and click "Add":

   https://github.com/pixel-clover/ariko.git?path=/Packages/io.github.pixel-clover.ariko
   

4. When the package is installed, you can open the assistant window by going to Tools > Ariko Assistant.

Configuring the Model Providers

To use Ariko, you need to provide an API key for the AI provider service you want to use (currently OpenAI and Google). To do this, follow these steps:

1. In the Ariko window, click the "Settings" button. This will open the settings panel.
2. Enter API Keys:
   • For better security, you can set your API keys as environment variables on your system, and Ariko will automatically load them.
     • OPENAI_API_KEY: Your API key for OpenAI.
     • GOOGLE_API_KEY: Your API key for Google.
     • OLLAMA_URL: The URL for your local Ollama instance (default: http://localhost:11434).
   • Alternatively, you can paste your keys directly into the corresponding fields in the settings panel.
3. Click the "Save and Close" button to save your settings.

Note

API keys are not stored between sessions due to security reasons. You will need to re-enter them each time you restart Unity unless you set them as environment variables.

Work Modes

Ariko can operate in two modes, which you can switch between at the top of the window:

• Ask Mode: A standard question-and-answer chat mode. Ariko will use its knowledge and the context you provide to answer your questions.
• Agent Mode: An mode where Ariko can perform actions in the editor, like creating, deleting, or modifying files and GameObjects.

Note

Agent mode is currently experimental and may be buggy.

---

Contributing

Please see CONTRIBUTING.md for details on how to get started.

Supporting the Project

If you find this project useful and want to support its development, please consider supporting it by making a donation via GitHub Sponsors and giving it a star on GitHub. Thank you!

License

Ariko is licensed under the MIT License (see LICENSE).

Acknowledgements

• The project logo is from SVG Repo with some modifications.