Skript AI

Skript AI is a local, addon-aware AI assistant for Minecraft Skript.

It is designed to behave like a language server / compiler assistant, not a chatbot.

---

✨ Features

• ✅ Strict Retrieval-Augmented Generation (RAG)
• ✅ Addon-aware syntax enforcement
• ✅ Fully local (LM Studio / OpenAI-compatible APIs)
• ✅ Multiple modes:
  • generate – create new Skript
  • edit – safely modify existing scripts
  • fix – diagnose and patch broken scripts
  • explain – explain Skript code
• ✅ Deterministic retries with validation
• ✅ Paper compatible

---

🧠 Core Philosophy

If the syntax is not documented, it does not exist.

The system:

• Only outputs syntax present in the retrieved SkriptHub corpus
• Refuses to hallucinate effects, expressions, or addon features
• Enforces addon availability strictly

---

🚫 What This Will NOT Do

• ❌ Use Bukkit / Spigot / Paper APIs
• ❌ Run Minecraft commands
• ❌ Invent addon syntax
• ❌ Act as a general chatbot

---

🛠 Supported Versions

• Skript 2.13.2
• Paper / Folia servers
• Addons configured via .env

---

📘 Setup

See the Setup Guide below.

---

📜 License

Internal / personal use (for now). License to be defined.

---

Setup Guide

1️⃣ Prerequisites

• Python 3.11+
• pip
• Git
• Local LLM backend (LM Studio recommended)

Supported models:

• qwen2.5-coder-7b-instruct
• deepseek-coder
• codestral (if available)

---

2️⃣ Clone the repo

git clone https://github.com/yourname/skript-ai.git
cd skript-ai

---

3️⃣ Create a virtual environment

python -m venv venv
source venv/bin/activate

---

4️⃣ Install dependencies

pip install -r requirements.txt

---

5️⃣ Configure environment

cp example.env .env

Edit .env as needed.

---

6️⃣ Download RAG and Start the server

python3 scrape_addons.py
uvicorn main:app --host 127.0.0.1 --port 8000

---

7️⃣ Test

curl -X POST http://127.0.0.1:8000/generate   -H "Content-Type: application/json"   -d '{
    "mode": "generate",
    "prompt": "make a command /heal that heals the player"
  }'