← Open Vanilla MANUALOPTIONAL

Use your own AI with Open Vanilla

Open Vanilla is open source, and your copy is yours to change. If you already use an AI coding agent, the launcher can point it at your Open Vanilla folder so it can make addons, restyle your interface, change your own Solo world or your Open Vanilla Server realm, and help you run it. You describe what you want; it edits the files and tells you how to test and undo it.

Honest small print. This is optional and runs on your PC. Open Vanilla has no AI of its own and no partnership with any AI company: you use your own agent and your own account with its maker, and Open Vanilla never asks for, stores or sends AI keys or logins. Everything the agent does stays on your copy and your own servers. The official Open Vanilla realm can't be changed from here.

What it can do

Make addons

From a first "hello" addon to windows and saved settings, written for the Vanilla client's Lua 5.0.

Fix errors

Paste an addon error; it finds the line, explains it and fixes your own addons.

Change your realm

XP and drop rates, a custom vendor or NPC, bot counts: on Play Solo or a realm you host.

Run your own realm

Walks you through Open Vanilla Server and reads its logs when something fails.

How to start

  1. Get an agent. Claude Code works best: it reads the kit's CLAUDE.md by itself. It needs a paid Claude plan or an Anthropic Console account. Other agents that edit files (Codex CLI, Gemini CLI, Aider, Cursor, VS Code with an agent) work too.
  2. Open the launcher: Settings → AI. It shows whether Claude Code is installed and has an Install Claude Code button if not.
  3. Set up AI workspace. Copies a short guide (CLAUDE.md, AGENTS.md) and the prompt library into your Open Vanilla data folder. Running it again refreshes the kit and leaves files you edited alone.
  4. Open in Claude Code. A terminal opens in that folder running claude. With another tool, press Open workspace folder, open it in your tool and ask it to read AGENTS.md.
  5. Paste a prompt. Copy one below, from the launcher, or in game (Esc → Assistant, or /assistant; press Ctrl+C in its box).

Safety rules

The prompt library

Replace the parts in <angle brackets>. The same prompts ship with the launcher and in the game.

Tour my Open Vanilla folder

A safe first prompt: the agent looks around and explains what is where. It changes nothing. Works on: Your copy, read-only.

Read CLAUDE.md, then look around this Open Vanilla folder without changing anything. Tell me in plain words: which addons I have in AddOns\Enabled and what each one does, whether Play Solo is set up (Realms\), and anything in Logs\ that looks like an error. End with three things you could help me do next.
Make my first addon

A tiny addon that says hello and adds a slash command, explained line by line. Works on: Your copy (AddOns\Enabled).

Read CLAUDE.md. Make me a small first addon called MyFirstAddon in AddOns\Enabled: when I log in it prints a friendly greeting with my character's name in chat, and /hello shows my level and current zone. Follow the Lua 5.0 rules for the Vanilla client. Explain each file and line simply, then tell me how to test it in game with /reload and how to remove it.
Fix an addon error

Paste the error from the game's error dialog and let the agent find and fix it. Works on: Your copy (your own or copied addons).

Read CLAUDE.md. An addon shows a Lua error in game. Here is the error text: <paste the error here>. Find which addon and line it comes from, check Logs\ for anything related, explain the cause in plain words, back the file up, and fix it following the Lua 5.0 rules. If it is one of the shipped Open Vanilla addons, don't edit it in place: tell me, and suggest a report or a separate fix addon instead.
Make a UI theme

Restyle fonts, colours and frame positions with a small addon of your own. Works on: Your copy (a new addon in AddOns\Enabled).

Read CLAUDE.md. Make me a small addon called MyTheme in AddOns\Enabled that restyles my interface: <describe the look you want, e.g. darker chat background, bigger font on the player and target frames, gold borders>. Keep everything in one addon I can switch off from the launcher, keep it Lua 5.0 safe, and add /mytheme to turn it on and off. Tell me how to test it with /reload.
Change my realm's XP rate

Faster (or slower) levelling on your own Solo world or Open Vanilla Server realm. Works on: Your own servers only (Play Solo, Open Vanilla Server).

Read CLAUDE.md. I want <2x> experience on my own realm: <Play Solo / my Open Vanilla Server realm>. Find the right config file for that realm, back it up, and change Rate.XP.Kill, Rate.XP.Quest and Rate.XP.Explore. Show me the lines you changed, how to restart the realm, and how to undo it.
Add a custom NPC or vendor

A new vendor on your own server, written as a reviewable SQL file first. Works on: Your own servers only (the world database on this PC).

Read CLAUDE.md. On my own <Play Solo / hosted> realm, add a custom vendor NPC called <name> who sells <items>. Use a new entry number above 190000, write the change as a .sql file in Agent\sql\ first and explain it to me before running anything, back up what you touch, and tell me the GM command to spawn the NPC where I stand (.npc add <entry>) and how to remove it again.
Host a realm for friends

Step-by-step help getting Open Vanilla Server running and your friends connected. Works on: Your PC and your own realm.

Read CLAUDE.md. Help me run my own realm for friends with Open Vanilla Server (openvanilla.app/host.html). Check whether SPP Classics is set up (Realms\Solo or C:\SPP_Classics_V2), walk me through Open Vanilla Server one step at a time, explain the choice between my home network and the internet (the internet shows my IP address to the people I invite), and if something fails, read Open Vanilla Server's logs and tell me what to fix. Don't change my router or firewall yourself: tell me what to do.
GM commands cheat sheet

Make yourself a GM on your own realm and get a cheat sheet that fits it. Works on: Your own servers only.

Read CLAUDE.md. Help me use GM commands on my own <Play Solo / hosted / dedicated> realm: explain how to give my account GM level 3 there, then write me a one-page cheat sheet as Agent\gm-cheatsheet.md with the commands I'll use most (teleport, level up, add items, spawn and delete NPCs, server info), checked against this server's own .help output where you can.
Back up my characters and settings

A one-click style backup of your addons, settings and realm data. Works on: Your copy and your own servers.

Read CLAUDE.md. Make a backup of my Open Vanilla stuff into Backups\manual-<today's date>\: AddOns\, Settings\ (leave out any saved password), Game\benilla-config\ and the config files of my realms in Realms\. For realm characters, tell me how to use the launcher's Backup button or export the character database safely. Then write a short Backups\HOW-TO-RESTORE.txt.