Upload README.md with huggingface_hub

README.md

@@ -11,37 +11,82 @@ pipeline_tag: text-generation
 
 # EditorAI Mini
 
-A fine-tuned Qwen2.5-0.5B-Instruct model that generates Geometry Dash levels as JSON.
+A fine-tuned Qwen2.5-0.5B-Instruct model that generates Geometry Dash levels as JSON — with blocks, spikes, platforms, triggers, groups, color channels, and more.
 
-Trained on hand-crafted expert examples with triggers, groups, color channels, and proper GD level structure.
+Part of the [EditorAI](https://github.com/Entity12208/EditorAI) project — an AI-powered level generator mod for Geometry Dash.
 
-## Usage with Ollama
+## About EditorAI
+
+[EditorAI](https://github.com/Entity12208/EditorAI) is a [Geode](https://geode-sdk.org) mod for Geometry Dash that lets you describe a level in plain text and have AI build it in the editor. It supports 8 AI providers (Gemini, Claude, OpenAI, Mistral, HuggingFace, Ollama, LM Studio, llama.cpp) and features blueprint preview, feedback learning, 15+ trigger types, and an in-game settings UI.
+
+## Model Details
+
+- **Base model:** Qwen2.5-0.5B-Instruct
+- **Training:** QLoRA (4-bit, rank 8) on hand-crafted expert GD level examples
+- **Features:** Blocks, spikes, platforms, color triggers, move triggers, alpha triggers, rotate triggers, toggle triggers, pulse triggers, speed portals, groups, color channels
+- **GGUF quantization:** q4_k_m (379 MB)
+
+## Files
+
+| File | Size | Description |
+|------|------|-------------|
+| `model.safetensors` | 943 MB | Merged fp16 model weights |
+| `editorai-mini.gguf` | 379 MB | Quantized GGUF (q4_k_m) for llama.cpp / LM Studio |
+| `config.json` | — | Model architecture config |
+| `tokenizer.json` | — | Tokenizer |
+
+## Usage with llama.cpp
 
 ```bash
 # Download the GGUF
-# Place editorai-mini.gguf in a folder, create a Modelfile pointing to it
-ollama create entity12208/editorai:mini -f Modelfile
+wget https://huggingface.co/EditorAI-Geode/editorai-mini/resolve/main/editorai-mini.gguf
+
+# Run the server
+llama-server -m editorai-mini.gguf --port 8080
+
+# In the EditorAI mod: set provider to "llama-cpp", URL to http://localhost:8080
+```
+
+## Usage with LM Studio
+
+1. Download `editorai-mini.gguf` from this repo
+2. Place it in your LM Studio models folder
+3. Load the model in LM Studio and start the server
+4. In the EditorAI mod: set provider to "lm-studio", URL to `http://localhost:1234`
+
+## Usage with Ollama
+
+This model is also available on Ollama:
+
+```bash
+ollama pull entity12208/editorai:mini
 ollama run entity12208/editorai:mini
 ```
 
-## Usage with EditorAI Mod
+In the EditorAI mod: set provider to "ollama" and select `entity12208/editorai:mini`.
 
-1. Install [EditorAI](https://github.com/Entity12208/EditorAI) for Geometry Dash (Geode mod)
-2. Set provider to **Ollama** and select `entity12208/editorai:mini`
-3. Generate levels!
+## Output Format
 
-## Model Details
+The model generates JSON in this format:
 
-- **Base model:** Qwen2.5-0.5B-Instruct
-- **Training:** QLoRA (4-bit, rank 8) on expert-crafted GD level examples
-- **Features:** Blocks, spikes, platforms, color triggers, move triggers, alpha triggers, rotate triggers, toggle triggers, pulse triggers, speed portals, groups, color channels
-- **GGUF quantization:** q4_k_m (379 MB)
+```json
+{
+  "analysis": "A medium modern level with color transitions and moving platforms.",
+  "objects": [
+    {"type": "block_black_gradient_square", "x": 0, "y": 0, "color_channel": 10},
+    {"type": "spike_black_gradient_spike", "x": 50, "y": 0},
+    {"type": "color_trigger", "x": 80, "y": 0, "color_channel": 1, "color": "#0066FF", "duration": 1.5},
+    {"type": "move_trigger", "x": 90, "y": 0, "target_group": 1, "move_x": 0, "move_y": 20, "duration": 1.0, "easing": 1},
+    {"type": "end_trigger", "x": 400, "y": 0}
+  ]
+}
+```
 
-## Files
+## Links
 
-- `model.safetensors` — merged fp16 model weights
-- `editorai-mini.gguf` — quantized GGUF (q4_k_m) for Ollama/llama.cpp
-- `Modelfile` — Ollama model definition with system prompt
+- **Mod:** [github.com/Entity12208/EditorAI](https://github.com/Entity12208/EditorAI)
+- **Ollama:** [ollama.com/entity12208/editorai](https://ollama.com/entity12208/editorai)
+- **Discord:** [discord.gg/5hwCqMUYNj](https://discord.gg/5hwCqMUYNj)
 
 ## License