A cross-platform virtual tabletop for multiplayer card games
C++ CMake C JavaScript HTML Shell Other

README.md


Cockatrice | Download | Get Involved | Community | Translations | Build | Run | License



To get started, ⇢ view our webpage
To get support or suggest changes ⇢ file an issue (How?) To help with development, see how to get involved

Cockatrice

Cockatrice is an open-source, multiplatform program 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 Qt5 libraries.

Download Cockatrice Eternal Download Count

Downloads are available for full releases and the current beta version in development.
Full releases are checkpoints featuring major feature or UI enhancements - we recommend to use those. There is no strict schedule for new full releases.

The beta release contains the most recently added features and bugfixes, but can be unstable. They are released as we feel need.

  • Latest stable release (recommended): Download from GitHub Releases DL Count on Latest Release

  • Latest beta release: Download from GitHub Pre-Releases DL Count on Latest Pre-Release

    • Beta versions may be unstable and contain bugs.
    • To be a Cockatrice Beta Tester, use this version. Find more information here!

Get Involved Gitter Chat

Chat with the Cockatrice developers on Gitter. Come here to talk about the application, features, or just to hang out. For support regarding specific servers, please contact that server's admin or forum for support rather than asking here.

To contribute code to the project, please review the guidelines. We maintain two tags for contributors to find issues to 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 a contributor to work on. Often this is for feature suggestions we are willing to accept, 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 review for changes they submit.

Read the long-term project roadmap to see planned edits and milestones here.

We try to be responsive to new issues. We'll provide advice on how best to implement a feature; alternately, we can show you where the codebase is doing something similar before you get too far along.

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

Community Resources

Translations Cockatrice on Transiflex

Cockatrice uses Transifex for translations. You can help us bring Cockatrice and Oracle to your language or just edit single wordings right from within your browser by visiting our Transifex project page.

Cockatrice Oracle
Cockatrice Translation Status Oracle Translation Status

Check out our Translator FAQ for more information about contributing!

Build Travis Build Status - master Appveyor Build Status - master

Detailed compiling instructions are on the Cockatrice wiki under Compiling Cockatrice

Dependencies:

Oracle can optionally use zlib to load zipped files:

To compile:

mkdir build
cd build
cmake ..
make

You can then run

make install

to get a cockatrice installation inside the release folder, or:

make package

to create a system-specific installation package.

The following flags can be passed to cmake:

  • -DWITH_SERVER=1 Whether to build the server (default 0 = no).
  • -DWITH_CLIENT=0 Whether to build the client (default 1 = yes).
  • -DWITH_ORACLE=0 Whether to build oracle (default 1 = yes).
  • -DCMAKE_BUILD_TYPE=Debug Compile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings (default Release).
  • -DWARNING_AS_ERROR=0 Whether to treat compilation warnings as errors in debug mode (default 1 = yes).
  • -DUPDATE_TRANSLATIONS=1 Configure make to update the translation .ts files for new strings in the source code. Note: Running make clean will remove the .ts files (default 0 = no).
  • -DTEST=1 Enable regression tests (default 0 = no). Note: needs googletest, will be downloaded on the fly if unavailable. To run tests: make test.

Run

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

Servatrice Docker container

You can run an instance of Servatrice (the Cockatrice server) using Docker and the Cockatrice Dockerfile.

First, create an image from the Dockerfile
cd /path/to/Cockatrice-Repo/ docker build -t servatrice .
And then run it
docker run -i -p 4747:4747/tcp -t servatrice:latest

Note: Running this command exposes the TCP port 4747 of the docker container
to permit connections to the server.

Find more information on how to use Servatrice with Docker in our wiki.

License GPLv2 License

Cockatrice is free software, licensed under the GPLv2.