{"id":51636919,"url":"https://github.com/nardo86/azeroth-companion","last_synced_at":"2026-07-13T15:03:22.922Z","repository":{"id":364748411,"uuid":"1269074588","full_name":"Nardo86/azeroth-companion","owner":"Nardo86","description":"In-game AI chatbot for World of Warcraft (3.3.5a → retail): quest, dungeon \u0026 raid help grounded in your live game state, via any OpenAI-compatible endpoint.","archived":false,"fork":false,"pushed_at":"2026-06-14T09:56:36.000Z","size":105,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T11:17:09.275Z","etag":null,"topics":["3-3-5a","chatbot","llm","lua","openai","questie","warmane","world-of-warcraft","wotlk","wow-addon"],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nardo86.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-14T09:25:24.000Z","updated_at":"2026-06-14T09:56:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Nardo86/azeroth-companion","commit_stats":null,"previous_names":["nardo86/azeroth-companion"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Nardo86/azeroth-companion","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nardo86%2Fazeroth-companion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nardo86%2Fazeroth-companion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nardo86%2Fazeroth-companion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nardo86%2Fazeroth-companion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nardo86","download_url":"https://codeload.github.com/Nardo86/azeroth-companion/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nardo86%2Fazeroth-companion/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35426086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-13T02:00:06.543Z","response_time":119,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3-3-5a","chatbot","llm","lua","openai","questie","warmane","world-of-warcraft","wotlk","wow-addon"],"created_at":"2026-07-13T15:03:21.301Z","updated_at":"2026-07-13T15:03:22.915Z","avatar_url":"https://github.com/Nardo86.png","language":"Lua","funding_links":["https://paypal.me/ErosNardi"],"categories":[],"sub_categories":[],"readme":"# Azeroth Companion\n\n**An in-game AI chatbot for World of Warcraft** that helps you with quests,\ndungeons and raids — grounded in what you're *actually* doing right now (your\nlive quest log, location, target, role and instance), and powered by any\nOpenAI-compatible model you choose (including **free** ones).\n\nBuilt to work from **WotLK 3.3.5a** (Warmane \u0026 other private servers) up through\nWotLK/Cata Classic and modern retail, via a runtime compatibility layer.\n\n☕ **[Buy me a coffee](https://paypal.me/ErosNardi)** — if this saved you some time.\n\n\u003e ⚠️ **Read this first — the one thing that shapes everything:** WoW addons run\n\u003e in a sandbox with **no internet access** (no sockets, no HTTP, no file I/O).\n\u003e An addon *alone* can never call an AI API. Azeroth Companion therefore has two\n\u003e parts: the **in-game addon** and a tiny **companion app** that runs on your PC\n\u003e and does the network call for it. See [How it works](#how-it-works).\n\n---\n\n## Features\n\n- 💬 **In-game chat window** — ask questions in natural language, get answers in\n  a dedicated, movable window. Type `/ac` to open it.\n- 🧭 **Quest help, grounded in your real quest log** — it reads your active\n  quests, objectives and progress live from the game and tells you *what to\n  kill, what to collect, who to talk to, and roughly where*. Never generic.\n- 📍 **Coordinates via Questie or pfQuest (optional)** — if you run\n  [Questie](https://github.com/Krigsgaldrnet/Questie-3.3.5) or\n  [pfQuest](https://github.com/shagu/pfQuest), it borrows exact spawn/turn-in\n  coordinates from their in-memory database at runtime (Questie preferred, then\n  pfQuest). Reading the version's own helper keeps this version-agnostic. No\n  helper? It falls back to directions by zone and landmarks.\n- ⚔️ **Role-aware dungeon \u0026 raid coaching** — detects your spec/role (or lets\n  you override it) and gives **tank / healer / DPS**-specific positioning and\n  the mechanics that matter, backed by a bundled, verified WotLK knowledge base\n  (every 5-man + all the raids: Naxx, Ulduar, ToC, ICC, RS, …).\n- 🚀 **High-XP server quest optimization** — tell it your realm's XP rate\n  (e.g. Warmane 5x with `/ac xp 5`) and it helps you decide which quests to\n  **skip** (trivial/gray) versus **keep** (chain → reward/attunement/next-zone\n  breadcrumb).\n- 🔌 **Bring your own model** — OpenRouter, Groq, Google Gemini, or fully-local\n  **Ollama** (offline, private, free). One config file: endpoint + key + model.\n- 🌍 **Cross-version** — one addon, multiple `.toc`s and a runtime compat layer\n  for 3.3.5a / Wrath Classic / Cata Classic / retail.\n- 🗣️ **Replies in your language** — the UI is English; the bot answers in the\n  language you set (`/ac lang it`, `en`, `es`, …). Defaults to your client locale.\n\n---\n\n## How it works\n\n```\n   ┌─────────────────────────┐         ┌──────────────────────────┐        ┌────────────┐\n   │   WoW client (addon)     │         │   Companion app (PC)     │        │  LLM API   │\n   │                          │         │                          │        │ (your key) │\n   │ reads quest log / role / │  file   │ watches SavedVariables,  │  HTTPS │            │\n   │ target / instance  ──────┼────────▶│ builds a role/version-   │───────▶│  model     │\n   │ writes question+context  │ outbox  │ aware prompt, calls API  │◀───────│  answer    │\n   │                          │         │                          │        └────────────┘\n   │ shows the answer  ◀──────┼─────────┤ writes _Inbox.lua        │\n   └─────────────────────────┘  file    └──────────────────────────┘\n                                inbox\n```\n\nBecause the sandbox blocks networking, the two halves talk through **files** —\nthe only channel available — using two conflict-free lanes:\n\n- **Outbox (addon → companion):** the addon writes your question + a JSON\n  snapshot of your situation into its **SavedVariables**, which WoW flushes to\n  disk on `/reload`. The companion only *reads* this.\n- **Inbox (companion → addon):** the companion writes the answer into\n  `_Inbox.lua` inside the addon's own folder. WoW re-reads that file on the next\n  `/reload` and **never overwrites it** (it only ever writes to `WTF/`), so the\n  answer can't be clobbered.\n\nPayloads are **Base64(JSON)** in both directions — robust, and the inbound file\ncontains *only data* (no executable Lua), so the companion can't inject code\ninto your client.\n\n### The trade-off you should know about\n\nOn 3.3.5a this round-trip needs a **UI reload** to flush the question and\nanother to pick up the answer (the addon can do this for you automatically — a\nbrief screen flash). It's a *consultation tool*, not a real-time stream: ask,\nwait a couple of seconds, read. This is inherent to the sandbox; there is no\nway around it on an unmodified client. You can disable auto-reload (`/ac auto\noff`) and fetch manually, or use the **clipboard mode** (`/ac paste`) for a\nno-reload flow. (On **retail**, silent timer-driven reloads are restricted, so\nmanual/clipboard mode is recommended there.)\n\n---\n\n## Installation\n\n**You need both parts.** Full per-OS details in [docs/INSTALL.md](docs/INSTALL.md).\n\n### 1. The addon\nCopy the folder `addon/AzerothCompanion` into your client's\n`Interface/AddOns/` directory, so you end up with\n`Interface/AddOns/AzerothCompanion/AzerothCompanion.toc`. Enable it on the\ncharacter screen (tick *Load out of date AddOns* on 3.3.5 if needed).\n\n### 2. The companion app\n- **Easiest:** download the prebuilt executable for your OS from the\n  [Releases](https://github.com/Nardo86/azeroth-companion/releases) page,\n  put it next to a `config.json`, and run it.\n- **From source (needs Python 3.8+, no extra packages):**\n  ```bash\n  cd companion\n  cp config.example.json config.json   # then edit it\n  python3 azeroth_companion.py\n  ```\n\n### 3. Configure (get a free AI key)\nCopy `companion/config.example.json` to `config.json` and set your\n`endpoint`, `api_key`, `model`, and your `wow_installs` path.\n\n👉 **Never done this before? Follow the click-by-click, no-jargon guide:\n[docs/SETUP-ENDPOINT.md](docs/SETUP-ENDPOINT.md).** It walks you through getting\na **free** key in ~3 minutes (no credit card). Reference: [docs/CONFIG.md](docs/CONFIG.md).\n\nThen launch the companion **while you play** — keep it running in the background.\n\n---\n\n## Usage\n\n| Command | What it does |\n|---|---|\n| `/ac` | Toggle the chat window |\n| `/ac \u003cquestion\u003e` | Ask directly from the chat line |\n| `/ac get` | Fetch a pending answer now (manual refresh) |\n| `/ac role \u003cauto\\|tank\\|healer\\|dps\u003e` | Override the detected role |\n| `/ac xp \u003cnumber\u003e` | Set your realm's XP multiplier (e.g. `5`) |\n| `/ac lang \u003cauto\\|it\\|en\\|…\u003e` | Set the reply language |\n| `/ac verbosity \u003cshort\\|normal\\|detailed\u003e` | Answer length |\n| `/ac auto \u003con\\|off\u003e` | Toggle automatic reload-to-send/fetch |\n| `/ac paste` | Paste an answer (clipboard / no-reload mode) |\n| `/ac status` | Show current settings |\n\n**Example questions**\n- *\"What do I still need to kill for my active quests in this zone?\"*\n- *\"I'm tanking Utgarde Keep, what should I watch on the last boss?\"*\n- *\"I'm a resto druid in Naxx — where do I stand on Heigan and what do I heal through?\"*\n- *\"I'm level 74 on a 5x realm, which of my quests are worth keeping?\"*\n\n---\n\n## Free model options\n\n| Provider | Endpoint | Example free model | Notes |\n|---|---|---|---|\n| **Groq** *(recommended)* | `https://api.groq.com/openai/v1` | `llama-3.3-70b-versatile` | No card; ~30 rpm / 1000 per day; very fast; steadiest free tier |\n| **OpenRouter** | `https://openrouter.ai/api/v1` | `meta-llama/llama-3.3-70b-instruct:free` | No card; `:free` models; ~20 rpm / 50–1000 per day |\n| **Google Gemini** | `https://generativelanguage.googleapis.com/v1beta/openai/` | `gemini-2.5-flash` | Key from AI Studio; may train on free-tier data |\n| **Ollama (local)** | `http://localhost:11434/v1` | `llama3.2` | 100% offline \u0026 private; no key |\n\nRun `python3 azeroth_companion.py --list-presets` to print these.\nFree rosters and limits change often — the `model` field is yours to edit.\nYou can also list **several endpoints** and have the companion fall back\nautomatically when one is rate-limited or down — see\n[docs/CONFIG.md](docs/CONFIG.md#multiple-endpoints-automatic-fallback).\n\n---\n\n## Compatibility\n\n| Client | `.toc` | Status |\n|---|---|---|\n| WotLK **3.3.5a** (Warmane, etc.) | `AzerothCompanion.toc` (Interface 30300) | **Primary target** |\n| WotLK Classic | `AzerothCompanion_Wrath.toc` | Supported (compat layer) |\n| Cata Classic | `AzerothCompanion_Cata.toc` | Supported (compat layer) |\n| Retail | `AzerothCompanion_Mainline.toc` | Supported; manual/clipboard mode recommended |\n| TBC / Vanilla Classic | `_TBC.toc` / `_Vanilla.toc` | Best-effort |\n\nThe addon never calls a version-specific API directly — everything goes through\n`Core/Compat.lua`, which feature-detects the right function at runtime\n(e.g. old `GetQuestLogTitle` vs `C_QuestLog.GetInfo`).\n\n---\n\n## Privacy \u0026 safety\n\n- Your **API key never leaves your PC** — it lives in the companion's\n  `config.json`, never in the addon or its SavedVariables.\n- The questions you ask and the context snapshot (your quests/zone/role) are\n  sent to **the model provider you chose**. For maximum privacy use **Ollama**\n  (fully offline). Note Gemini's free tier may use prompts to improve Google.\n- The companion writes **only data** into the addon folder (Base64/JSON), never\n  executable Lua — no code-injection path into your client.\n\n---\n\n## Limitations \u0026 roadmap\n\n- Turn-based, not real-time (the reload trade-off above).\n- Quest reward **XP** is readable on 3.3.5a but not on Classic clients (Blizzard\n  removed the API); skip-advice there relies on quest level vs. yours.\n- Localized clients may not match the English knowledge-base instance names; the\n  model still answers from general knowledge.\n- Roadmap ideas: a watcher that auto-presses reload on a hotkey, a bundled\n  lightweight coordinate DB (no quest helper needed), per-class tips,\n  packaged installers.\n\nContributions welcome — see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).\n\n---\n\n## Support\n\nIf Azeroth Companion is useful to you:\n\n⭐ Star the repo • 🐛 [Open an issue](https://github.com/Nardo86/azeroth-companion/issues) • 🔧 Send a PR • ☕ **[Buy me a coffee](https://paypal.me/ErosNardi)**\n\n---\n\n## Credits \u0026 license\n\nAzeroth Companion is released under the [MIT License](LICENSE).\nBundled third-party code and data sources are listed in\n[docs/CREDITS.md](docs/CREDITS.md) (notably `json.lua` by rxi, MIT). Questie is\n**not** bundled — it's used at runtime only if you have it installed.\n\nThis is a fan project and is not affiliated with or endorsed by Blizzard\nEntertainment. World of Warcraft is a trademark of Blizzard Entertainment, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnardo86%2Fazeroth-companion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnardo86%2Fazeroth-companion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnardo86%2Fazeroth-companion/lists"}