A cross-platform virtual tabletop for multiplayer card games https://cockatrice.github.io
Find a file
BruebachL 3cf8bdb00e
[Tests] Add a headless game logic regression suite (#7702)
* [Tests] Add headless game logic regression suite

Cover CardState, CardZoneLogic and the Command_MoveCard protobufs PlayerActions emits, against libcockatrice_game with a recording AbstractClient and no graphics. The old game_smoke_test cases are migrated into the new suite.

* [Tests] Cover game event application through GameEventHandler

Feeds GameEventContainers through the real dispatcher and asserts the resulting zone and card state: move (including face down), the set-card-attr attributes plus the all-cards and does-not-untap branches, card counters, attach/detach, zone reveal properties, and drawing named cards from the deck.

* [Tests] Replay a synthetic game state through the dispatcher

Builds a GameReplay in code, feeds its containers through the same GameEventHandler path the client uses, and asserts the materialized players, zones, cards and attachments plus event ordering for move, attributes and counters. A small headless zone view stands in for the graphics side where processPlayerInfo asks for card items.

* [Tests] Cover card flip, destroy, token and turn events

Adds the remaining state-mutating event handlers: flip (face down keeps the ref, face up adopts the printing), destroy (removes the card and un-attaches its attached cards), create token (database P/T unless provided or face down) and player properties changed under the concede/unconcede contexts, plus active player and phase.

* [Tests] Cover player lifecycle and counter events

Adds the player-level events that mutate session state: leave removes the player from the manager, kicked emits gameClosed, game closed flips the closed flag and clears the started flag, host changed moves the host role to another player, and create/set/delete update the player counters with unknown ids ignored.

* [Tests] Drive the zone view request through addCard

The test emitted createCardRequested itself and then asserted it was emitted. Registering a ZoneViewZoneLogic on the zone and adding a card exercises the real prepareAddCard -> signal path, so the assertion now fails if addCard stops asking the graphics side to build the card.

* [Tests] Skip the card database when listing tests

gtest_discover_tests runs the binary with --gtest_list_tests during the build. That process built the card database and replaced its default path provider, leaving allocations that the sanitizer leg's default LeakSanitizer check reports at exit, so discovery failed on Ubuntu 26.04. No test runs in list mode, so return before the database setup.

* [Tests] Fix fixture comment nit

Wraps the RecordingClient::sent member name in backticks in the comment.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
2026-11-02 07:35:41 +01:00
.ci [CI] Make the hdiutil retry wrapper report failure (#7643) 2026-11-02 07:01:55 +01:00
.github [CI] Keep the vcpkg cache directory guard unconditional (#7527) 2026-10-31 18:49:45 +01:00
.tx [Translation] Move config into git version control (#7575) 2026-10-18 14:29:51 +02:00
cmake [Installer] Graceful close and a way out of a stuck update (#7687) 2026-10-31 15:32:59 +01:00
cockatrice [Settings] Store server profiles with QSettings arrays (#7629) 2026-11-02 07:30:29 +01:00
doc Support tab-separated deck imports (#4222) (#7267) 2026-10-11 21:19:10 +02:00
libcockatrice_card [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_deck_list [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_filters [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_game [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_interfaces [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_models [Tests] Use QtTest for model contracts and signal spies (#7630) 2026-11-02 07:27:43 +01:00
libcockatrice_network [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_protocol [Server/Client/Protocol] Let moderators clear banner cards (#7546) 2026-10-25 13:19:20 +01:00
libcockatrice_rng [Build] Configure AUTOMOC, AUTOUIC and AUTORCC once (#7637) 2026-11-02 07:06:47 +01:00
libcockatrice_settings [Settings] Store server profiles with QSettings arrays (#7629) 2026-11-02 07:30:29 +01:00
libcockatrice_utility [Utility] Budget scrypt's XY array in the derivation memory limit (#7712) 2026-11-02 07:29:15 +01:00
oracle [Build] Use versionless Qt CMake commands (#7639) 2026-10-31 18:53:00 +01:00
servatrice [Servatrice] Use compile-time checked connections (#7631) 2026-11-02 07:13:21 +01:00
tests [Tests] Add a headless game logic regression suite (#7702) 2026-11-02 07:35:41 +01:00
tools [Installer] Graceful close and a way out of a stuck update (#7687) 2026-10-31 15:32:59 +01:00
vcpkg@9eec002df1 bump vcpkg submodule (#7690) 2026-11-01 16:22:51 +01:00
.clang-format Enable RemoveSemicolon & update format.sh (#6896) 2026-05-16 20:26:37 +02:00
.cmake-format.json rework formatting with cmake-format (#4627) 2022-06-08 21:14:26 -04:00
.dockerignore Include git metadata in docker build context (#7393) 2026-10-04 03:48:15 +02:00
.gitignore [Card Database] Improve loading times through binary cache (#7051) 2026-07-27 23:12:53 +02:00
.gitmodules Docs: Use doxygen-awesome-css theme (#6512) 2026-01-24 11:22:43 +01:00
CMakeLists.txt [Version] Bump to 3.2.0 (#7762) 2026-11-02 07:28:14 +01:00
docker-compose.yml Docker compose: Link to our GHCR hosted servatrice image (#6728) 2026-03-22 10:28:24 +01:00
docker-compose.yml.windows Docker compose: Link to our GHCR hosted servatrice image (#6728) 2026-03-22 10:28:24 +01:00
Dockerfile [Security] Use a CSPRNG for salts, tokens, and RNG seeding (#7192) 2026-09-04 13:49:18 +02:00
Doxyfile [Docs] Add app logo to main page + cleanup (#7471) 2026-10-10 23:48:37 +02:00
format.sh [CI] Lint only .sh files in the shell formatting pass (#7715) 2026-11-02 07:29:05 +01:00
gcovr.cfg [CI] Publish a gcovr line-coverage report from the test run (#7404) 2026-10-11 15:05:28 +02:00
iwyu.sh [Tooling] Add IWYU Qt6 mapping, generator, and runner script (#7454) 2026-10-08 11:17:01 +02:00
LICENSE update the address of the fsf in the license (#6113) 2025-09-10 18:18:34 -04:00
publish_beta.sh [Tooling] Add publish_beta.sh to automate Development beta tagging (#7505) 2026-10-19 15:01:18 +02:00
qt6.imp [Tooling] Add IWYU Qt6 mapping, generator, and runner script (#7454) 2026-10-08 11:17:01 +02:00
README.md [README] Small tweaks (#7585) 2026-10-22 20:13:43 +02:00
shell.nix nix: Add development utilities to shell.nix (#5725) 2025-03-15 19:03:26 +00:00
vcpkg.json bump vcpkg submodule (#7690) 2026-11-01 16:22:51 +01:00


Cockatrice | Download | Related | Community | Contribute | Build | Run



To get started with Cockatrice ⇢ view our webpage To get support, or suggest changes to the app ⇢ file an issue (How?)
To learn about the app and its code ⇢ read our code documentation To help with development ⇢ learn how to contribute


Cockatrice

Cockatrice is an open-source, multiplatform application for playing tabletop card games over a network. The program's server design prevents users from manipulating the game for unfair advantage. The client also provides a single-player mode, which allows users to brew while offline.

This project uses C++ and the Qt libraries.

Download Cockatrice Eternal Download Count

Downloads are available for stable releases and the current beta version in development.
There is no strict release schedule for either of them.

Latest stable release:
Download Stable Release  
Latest beta version:
Download Beta Release   
While incorporating the latest fixes and features, beta builds may not be stable or contain new bugs!
Please report any findings and open new issues when testing them!

Related Repositories

Community Resources Discord

Join our Discord community to connect with other project contributors (#dev channel) or fellow users of the app. Come here to talk about the application, features, or just to hang out.

Important

For support regarding specific servers, please contact that server's admin/mods and use their dedicated communication channels rather than contacting the team building the software.

Contribute

Code | Documentation | Translation

Repository Activity

Cockatrice Repo Analytics

Kudos to all our amazing contributors ❤️

Made with contrib.rocks

Code

To commit code to the project, please review our Contribution Guidelines first.
We maintain two tags for contributors to easier find issues to potentially work on:

  • Good first issue
    Issues tagged in this way provide a simple way to get started. They don't require much experience to be worked on.
  • Help wanted
    This tag is used for issues that we are looking for somebody to pick up. Often this is for feature suggestions we support, but don't have the time to work on ourselves.

For both tags, we're willing to provide help to contributors in showing them where and how they can make changes, as well as code reviews for submitted changes.
We'll happily advice on how best to implement a feature, or we can show you where the codebase is doing something similar before you get too far along - put a note on an issue you want to discuss more on!

You can also have a look at our Todo List in our Code Documentation or search the repo for \todo comments.

Documentation CI Docs

There are various places where useful information for different needs are maintained:

Cockatrice tries to use the Google Developer Documentation Style Guide to ensure consistent documentation.
We encourage everybody to improve the documentation by suggesting edits based on this guide.

Translation Transifex Project

Cockatrice uses Transifex to manage translations. You can help us bring Cockatrice and Oracle to your language and just adjust single wordings right from within your browser by visiting our Transifex project page. The Webatrice web client manages its own translations in its repo.

Check out our Translator FAQ for more information about getting involved, and join a group of hundreds of others!

Build CI Desktop CI Docker

Dependencies: (for minimum versions search our CMake file)

Oracle can optionally use some packages to load compressed card files:


Basic compilation steps:

mkdir build
cd build
cmake ..
make

You can then

  • Create a Cockatrice installation inside the release folder:
    make install
    
  • Or make an installation package specific to your system:
    make package
    

Note

Detailed compiling instructions can be found in the Cockatrice wiki at Compiling Cockatrice


The following flags (with their non-default values) can be passed to cmake:

Flag Description
-DWITH_SERVER=1 Build Servatrice server
-DWITH_CLIENT=0 Don't build Cockatrice client
-DWITH_ORACLE=0 Don't build Oracle card database tool
-DCMAKE_BUILD_TYPE=Debug Compile in debug mode
Enables extra logging output, debug symbols, and much more verbose compiler warnings
-DWARNING_AS_ERROR=0 Don't treat compilation warnings as errors in debug mode
-DUPDATE_TRANSLATIONS=1 Configure make to update the translation .ts files for new strings in the source code
Note: make clean will remove the .ts files
-DTEST=1 Enable regression tests
Note: make test to run tests, googletest will be downloaded if not available

Tip

Build code documentation (Doxygen) according to our configuration into /docs:

doxygen Doxyfile

Run

Cockatrice is the game client
Oracle fetches card data
Servatrice is the server

Docker

You can build an image & deploy a Servatrice (Cockatrice server) container using Docker and our Dockerfile yourself.

For more details, look into our wiki section on Setting up Servatrice.
You'll also find more hints on our pre-build image there, or the docker-compose file which will configure and run both a MySQL server and Servatrice.

License GPLv2 License

Cockatrice is free software, licensed under the GPLv2.