> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lootroute.volvox.bot/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> LootRoute by Volvox is a World of Warcraft gathering automation framework and bot, written in Lua and run in-game by the WGG unlocker.

**LootRoute by Volvox** is a World of Warcraft gathering bot (herbalism, mining, and fishing) written in **Lua**. It runs **inside the game**, loaded by the third-party **WGG** unlocker. The project has two layers:

* **The framework** — the shared `volvox` table: a module system, per-character JSON config store, in-game settings UI (built on the bundled StdUi toolkit), minimap button, event/combat-log dispatcher, and logging.
* **The LootRoute bot** — the flagship plugin built on the framework: route following, node scanning, combat handling, flight and skyriding, and quality-of-life tasks such as mailing and repairs.

<Warning>
  Automating gameplay with an unlocker violates the World of Warcraft Terms of Service and can result in account suspension or a permanent ban. This project is provided for educational purposes; use it at your own risk.
</Warning>

## How it works

WGG loads each Lua file listed in `loadorder.json` at the repository root, in order, invoking every file with two varargs:

```lua theme={null}
local WGG, volvox = ...
```

* **`WGG`** — the unlocker API: object scanning, movement, protected calls, tracelines, HTTP, and file I/O. See the [WGG API documentation](https://docs.8g90jerssb.space/).
* **`volvox`** — the shared framework table threaded through every file. It is the bus for all cross-file state and services.

`Main.lua` loads last and starts the runtime via `volvox:Init()`.

## Explore the docs

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Get LootRoute loading through WGG.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Open the settings window and start your first gathering run.
  </Card>

  <Card title="Architecture" icon="sitemap" href="/architecture">
    Load order, the runtime contract, and how the layers fit together.
  </Card>

  <Card title="LootRoute bot" icon="leaf" href="/gatherer/overview">
    The state machine, routes, node databases, and configuration.
  </Card>

  <Card title="Framework reference" icon="book" href="/framework/runtime">
    Full API reference for every `volvox.*` service.
  </Card>

  <Card title="Development" icon="code" href="/development/tooling">
    Static tooling, conventions, and the release process.
  </Card>
</CardGroup>

## Authoritative external references

| Reference                                                                  | Use for                                                            |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [WGG API docs](https://docs.8g90jerssb.space/)                             | Every unlocker call — names, parameters, returns, failure behavior |
| [Wowpedia WoW API](https://wowpedia.fandom.com/wiki/World_of_Warcraft_API) | Standard World of Warcraft API functions                           |
| [Wowhead](https://www.wowhead.com/)                                        | Every numeric game ID — items, GameObjects, spells, NPCs, zones    |