Skip to content

opentibiabr/canary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2,315 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Canary

Discord CI Quality Gate Status Repository size 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 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


Recommended Tools and Clients


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.


Running Tests

Tests can be run directly from the repository root using CMake test presets:

# Configure and build tests for your platform
cmake --preset linux-debug && cmake --build --preset linux-debug

# Run all tests
ctest --preset linux-debug

# For other platforms use:
# ctest --preset macos-debug
# ctest --preset windows-debug

For detailed testing information including adding tests and framework usage, see tests/README.md.


Support & Community

For real-time support, join the OpenTibiaBR Discord.

The GitHub issue tracker should be used for bugs, improvements, and technical project tasks. It is not a support forum.


Contributing

Contributions are welcome. You can help in several ways:

  • Report bugs through the Issue Tracker.
  • Submit improvements through Pull Requests.
  • Improve tests, documentation, scripts, datapacks, or C++ code.
  • Validate releases, nightly builds, and recent changes.

Before contributing, read the Code of Conduct and the project Contributing guide.


Sponsorship

Canary is maintained by community contributors. To support development, visit the OpenTibiaBR sponsors page.


Acknowledgements

Thanks to all contributors of Canary, OTServBR-Global and the OpenTibia community.


License

This project is distributed under the GPL-2.0 license.

Sponsor this project

Packages

 
 
 

Contributors

Languages