agent-wow / agent-wow

agent-wow 
 AzerothCore WoW client designed for autonomous AI agent players. 
 Blog ·
 Gameplay demos on YouTube 
- How it works
- Getting Started
 - Requirements
 - Install
 - Quick start workspace
- Usage
 - Configuration
 - Default configuration
 - Full configuration options
 - Authentication
 - Commands
 - Realm
 - Character
 - Modules
 - Using modules for gameplay mechanics
 - How do modules work?
 - `module.proto` and `module.pb`
 - `module.yaml` and `compose.yaml`
 - Module Environment variables
 - Installing modules
 - Gameplay Session RPC methods
- Local development
 - Prerequisites
 - Commands
## How it works
 [code] 
## Getting Started
### Requirements
- Go 1.27.1 or newer to install from source.
- An AzerothCore server for WoW 3.3.5a and an existing account.
- Linux, a local Docker Engine, and Docker Compose to run modules.
- Optional but recommended for module development: `protoc` and your language's
 protobuf/gRPC plugins to generate bindings and descriptor sets.
### Install
 [code] 
Ensure Go's binary directory (`$(go env GOPATH)/bin`, or your custom `GOBIN`)
is on your `PATH`.
### Quick start workspace
You can use agent-wow-workspace
as a starting point for your AI agent. It includes agent instructions and a
`config.yaml` that keeps all assets within a single directory.
## Usage
### Configuration
The client reads an optional `config.yaml` in your current directory. To use
another file, pass `--config /path/to/config.yaml` with each command.
#### Default configuration
 [code] 
#### Full configuration options
Environment variables take precedence over file settings.
| Option | Environment variable | Default | Description |
| --- | --- | --- | --- |
| `config_dir` | `AGENT_WOW_CONFIG_DIR` | `~/.config/agent-wow` | Directory for credentials, realm selection, and modules. |
| `data_dir` | `AGENT_WOW_DATA_DIR` | `~/.local/share/agent-wow` | Directory for saved session data. |
| `module_dir` | `AGENT_WOW_MODULE_DIR` | ` /modules` | Directory containing installed module packages. |
| `auth_file_path` | `AGENT_WOW_AUTH_FILE_PATH` | ` /auth.json` | Account credentials file, written by `auth init`. |
| `realm_file_path` | `AGENT_WOW_REALM_FILE_PATH` | ` /realm.json` | Saved realm selection. |
| `authserver.host` | `AGENT_WOW_AUTHSERVER_HOST` | `localhost` | Authserver hostname or IP address. |
| `authserver.port` | `AGENT_WOW_AUTHSERVER_PORT` | `3724` | Authserver TCP port. |
| `worldrpc.host` | `AGENT_WOW_WORLDRPC_HOST` | `localhost` | Local gameplay API host; must be `localhost` or a loopback IP. |
| `worldrpc.port` | `AGENT_WOW_WORLDRPC_PORT` | `8086` | Local gameplay API port used by `char play`. |
| `log_level` | `AGENT_WOW_LOG_LEVEL` | `info` | Logging verbosity: `debug`, `info`, `warn`, or `error`. |
### Authentication
 [code] 
### Commands
Use ` --help` for all options. List commands support `--json` for scripting.
#### Realm
 [code] 
#### Character
 [code] 
#### Modules
 [code] 
### Using modules for gameplay mechanics
Modules are