Ariko

An AI assistant for Unity

---

Ariko is an open-source AI assistant for Unity game engine similar to GitHub Copilot.

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.

---

Getting Started

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.

Configuration

To use Ariko, you need to provide an API key for the AI service you want to use (like OpenAI and Google).

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 (example: 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.

Documentation

To be added.

---

Contributing

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

License

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

Acknowledgements

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