opentibiabr / canary

# Canary
Canary is a free and open-source MMORPG server emulator for the OpenTibia community, written in C++20 and Lua. It is a fork of the OTServBR-Global project. The repository includes the server core, datapacks, Lua scripts, database schema, build presets, automated tests and development tooling used by the project.
---
## Getting Started
- Wiki.
---
## Docker Quickstart
Canary includes a lightweight Docker quickstart for running a local test server
without compiling Canary locally. The stack starts MariaDB, the published Canary
runtime image, MyAAC as the website/admin AAC, and `opentibiabr/login-server` as
the client login webservice.
This quickstart is for local development, testing, and LAN demos. Do not expose
it directly to the public Internet with the default test accounts and passwords.
Run from the `docker` directory:
 [code] 
The `docker` directory also provides guarded start scripts that start the stack
and clean safe Docker leftovers without removing database volumes:
 [code] 
 [code] 
Default local endpoints:
- Website/admin: `http://localhost:8080`
- Client login webservice: `http://localhost:8088/login`
- Game port: `7172`
MyAAC's `login.php` is intentionally removed from the quickstart image. Clients
should use `login-server` only. See docs/docker/quickstart-for-beginners.md
for a beginner guide and docker/DOCKER.md for the full setup,
environment variables, test account, and troubleshooting guide.
---
## Documentation
- Recompile on Linux with executable backups.
 Covers seven-day retention, crash analysis, optional restart and WSL tests.
- Hardware sizing and capacity planning. Measure
 RAM and CPU, compare training and hunting workloads, and review capacity.
- Shared build cache for worktrees and forks.
- Docker beginner quickstart.
- Multiprotocol runtime profiles. Covers the
 current, 11.00, and 8.60 runtime contracts, port layout, client preparation,
 and validation checklist.
- System documentation.
- Lua API reference and VSCode IntelliSense stubs. Canary generates these files from the C++ Lua bindings during startup when `generateLuaApiDocs` is enabled. The repository `.luarc.json` already adds `docs/lua-api` to the Lua Language Server workspace library; for VSCode workspace settings, run `tools/setup_vscode_lua_api.ps1`.
---
## Recommended Tools and Clients
- Assets Editor. Use this as the
 single asset source of truth, then export legacy-compatible `.dat`/`.spr`
 packages for 8.60 clients from the same current asset set.
- Remere's Map Editor.
- OTClient Redemption.
- Tibia Extended Client Library.
 Use this to prepare compatible 8.60/11.00 CipSoft clients with extended
 limits, config-driven login redirect, and per-client local state.
- Game Client.
---
## Nightly Packages
Development builds can be downloaded from GitHub Actions artifacts. They are useful for testing recent changes from the `main` branch, but may include behavior that is not present in stable releases yet.
- Github Actions.
---
## Running Tests
Te