|
1 | 1 | # Editor AI |
2 | | - |
3 | 2 | AI-powered level generation for Geometry Dash. Describe your level in plain text and watch AI build it in the editor. |
4 | 3 |
|
5 | | -*Consider supporting the project by starring it on [Github](https://github.com/entity12208/editorai)* |
| 4 | +*Consider supporting the project by starring it on [GitHub](https://github.com/entity12208/editorai)* |
6 | 5 |
|
7 | 6 | ## Quick Start |
8 | | - |
9 | 7 | 1. Download the [latest release](https://github.com/entity12208/editorai/releases/latest) |
10 | 8 | 2. Open the game and navigate to the Geode page |
11 | 9 | 3. Press the manual download button and select the file |
12 | | -4. Set up the mod |
| 10 | +4. Set up the mod using one of the AI providers below |
13 | 11 |
|
14 | 12 | ## AI Setup |
15 | 13 |
|
16 | | -### Ollama |
| 14 | +### EditorAI Platinum *(Free — recommended)* |
| 15 | +[EditorAI Platinum](https://github.com/entity12208/editorai-platinum) is a community proxy that lets anyone run the official EditorAI Ollama models over the internet for free. |
| 16 | + |
| 17 | +1. In mod settings, set **AI Provider** to `ollama` |
| 18 | +2. Enable the **Use Platinum** toggle |
| 19 | +3. Select a model from the **Ollama Model** dropdown: |
| 20 | + - `entity12208/editorai:qwen` — more powerful |
| 21 | + - `entity12208/editorai:deepseek` — more creative |
17 | 22 |
|
18 | | -*Though Ollama does use ~5.2 GB storage, it is still the recommended option for anyone who has 6+ GB VRAM, as it is free permanently and easy to set up.* |
| 23 | +Want to donate your computer to the network? Follow the instructions in the [Platinum repository](https://github.com/entity12208/editorai-platinum). |
| 24 | + |
| 25 | +### Ollama *(Free — recommended for 6+ GB VRAM)* |
| 26 | +*Uses ~5.2 GB storage. Fully local and private — no internet required after setup.* |
19 | 27 |
|
20 | 28 | 1. Download and install [Ollama](https://ollama.com) |
21 | | -2. Download the official model by running `ollama pull entity12208/editorai:<model>`, where `model` can be either `deepseek` (more creative) or `qwen` (more powerful). Each is 5.2 GB. |
22 | | -3. Ensure the setting `ollama model` is set to `entity12208/editorai:<model>`. |
23 | | -4. Change the other settings to your requirements. |
| 29 | +2. Pull the official model: `ollama pull entity12208/editorai:<model>` |
| 30 | + - `deepseek` — more creative | `qwen` — more powerful (each ~5.2 GB) |
| 31 | +3. In mod settings, set **AI Provider** to `ollama` and leave **Use Platinum** off |
| 32 | +4. Select your model from the **Ollama Model** dropdown |
| 33 | + |
| 34 | +### Claude *(Paid)* |
| 35 | +1. Get an API key at [console.anthropic.com](https://console.anthropic.com) |
| 36 | +2. In mod settings, set **AI Provider** to `claude` and choose a model |
| 37 | +3. Paste your key into the **Claude API Key** field in mod settings |
24 | 38 |
|
25 | | -### Gemini, Claude, ChatGPT |
| 39 | +### Mistral AI *(Paid)* |
| 40 | +1. Get an API key at [console.mistral.ai](https://console.mistral.ai/api-keys/) |
| 41 | +2. In mod settings, set **AI Provider** to `ministral` and choose a model |
| 42 | +3. Paste your key into the **Mistral API Key** field in mod settings |
26 | 43 |
|
27 | | -1. Get your API key for [Gemini](https://aistudio.google.com/u/0/api-keys), [Claude](https://console.anthropic.com), or [ChatGPT](https://platform.openai.com/api-keys). |
28 | | -2. Set the setting `Model` to your perfered model used by your provider |
29 | | -3. Once in the UI, click the lock icon. |
30 | | -4. Paste your API key into the box and save it. |
| 44 | +### HuggingFace *(Free tier available)* |
| 45 | +1. Get a token at [huggingface.co/settings/tokens](https://huggingface.co/settings/tokens) |
| 46 | +2. In mod settings, set **AI Provider** to `huggingface` |
| 47 | +3. Enter a model ID in the model field (default: `meta-llama/Llama-3.1-8B-Instruct`) |
| 48 | +4. Paste your token into the **HuggingFace API Key** field in mod settings |
| 49 | + |
| 50 | +### ChatGPT *(Paid)* |
| 51 | +1. Get an API key at [platform.openai.com/api-keys](https://platform.openai.com/api-keys) |
| 52 | +2. In mod settings, set **AI Provider** to `openai` and choose a model |
| 53 | +3. Paste your key into the **OpenAI API Key** field in mod settings |
| 54 | + |
| 55 | +### Gemini *(Not recommended — tight rate limits)* |
| 56 | +1. Get an API key at [aistudio.google.com/api-keys](https://aistudio.google.com/u/0/api-keys) |
| 57 | +2. In mod settings, set **AI Provider** to `gemini` and choose a model |
| 58 | +3. Paste your key into the **Gemini API Key** field in mod settings |
31 | 59 |
|
32 | 60 | ## Usage |
| 61 | +1. Download and set up the mod |
| 62 | +2. Open the editor of any level |
| 63 | +3. Press the **AI** button in the top right |
| 64 | +4. Enable or disable **Clear Level**, and enter your prompt |
| 65 | +5. Click **Generate** and wait! |
33 | 66 |
|
34 | | -1. Download and set up the mod. |
35 | | -2. Open the editor of any level. |
36 | | -3. Press the AI button located in the top right. |
37 | | -4. Enable or disable `Clear Level`, and enter your prompt into the box. |
38 | | -5. Click `Generate` and wait! |
| 67 | +## Advanced Features |
| 68 | +Enable **Advanced Features** in mod settings to unlock: |
| 69 | +- **Color Triggers** — AI can place color triggers that smoothly transition background, ground, and object colors |
| 70 | +- **Move Triggers** — AI can create moving platforms and obstacles using grouped objects and move triggers with easing |
| 71 | +- **Group IDs** — AI assigns group IDs to objects so move triggers can target them precisely |
39 | 72 |
|
40 | | -## Support |
| 73 | +These features work best with smarter models (Claude, Ollama qwen, or Platinum). |
41 | 74 |
|
| 75 | +## Support |
42 | 76 | Join the [Editor AI Discord server](https://discord.gg/5hwCqMUYNj) for support and ideas. |
0 commit comments