canary

# Canary

[![Discord](https://img.shields.io/discord/528117503952551936.svg?style=flat-square&logo=discord)](https://discord.gg/gvTj5sh9Mp)
[![CI](https://github.com/opentibiabr/canary/actions/workflows/ci.yml/badge.svg)](https://github.com/opentibiabr/canary/actions/workflows/ci.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=opentibiabr_canary&metric=alert_status)](https://sonarcloud.io/dashboard?id=opentibiabr_canary)
![Repository size](https://img.shields.io/github/repo-size/opentibiabr/canary)
[![License](https://img.shields.io/github/license/opentibiabr/canary.svg)](https://github.com/opentibiabr/canary/blob/main/LICENSE)

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](https://github.com/opentibiabr/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](https://github.com/opentibiabr/canary/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:

```bash
cp .env.dist .env
docker compose up -d --build
```

The `docker` directory also provides guarded start scripts that start the stack
and clean safe Docker leftovers without removing database volumes:

```powershell
.\up.ps1
```

```bash
sh ./up.sh
```

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](docs/docker/quickstart-for-beginners.md)
for a beginner guide and [docker/DOCKER.md](docker/DOCKER.md) for the full setup,
environment variables, test account, and troubleshooting guide.

---

## Documentation

- [Recompile on Linux with executable backups](docs/building/recompile.md).
  Covers seven-day retention, crash analysis, optional restart and WSL tests.
- [Hardware sizing and capacity planning](docs/hardware-sizing.md). Measure
  RAM and CPU, compare training and hunting workloads, and review capacity.
- [Shared build cache for worktrees and forks](docs/development/shared-build-cache.md).
- [Docker beginner quickstart](docs/docker/quickstart-for-beginners.md).
- [Multiprotocol runtime profiles](docs/systems/multiprotocol.md). Covers the
  current, 11.00, and 8.60 runtime contracts, port layout, client