71 lines
3.5 KiB
Markdown
71 lines
3.5 KiB
Markdown
# Cockatrice
|
|
|
|
Cockatrice is an open-source multiplatform software for playing card games,
|
|
such as Magic: The Gathering, over a network. It is fully client-server based
|
|
to prevent any kind of cheating, though it supports single-player games without
|
|
a network interface as well. Both client and server are written in Qt, supporting both Qt4 and Qt5.
|
|
|
|
# Get Involved [](https://gitter.im/Cockatrice/Cockatrice)
|
|
|
|
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.
|
|
|
|
# Community Resources
|
|
- [reddit r/Cockatrice](http://reddit.com/r/cockatrice)
|
|
- [Woogerworks Server & Forums](http://www.woogerworks.com)
|
|
- [Cockatrice Official Wiki](https://github.com/Cockatrice/Cockatrice/wiki)
|
|
|
|
# Translation Status [](https://www.transifex.com/projects/p/cockatrice/)
|
|
|
|
Cockatrice uses Transifex for translations. You can help us bring Cockatrice/Oracle to your language or edit single wordings by clicking on the associated charts below.<br>
|
|
Our [project page](https://www.transifex.com/projects/p/cockatrice/) offers a detailed overview for contributors.
|
|
|
|
Language statistics for `Cockatrice` *(on the left)* and `Oracle` *(on the right)*:
|
|
|
|
[](https://www.transifex.com/projects/p/cockatrice/resource/cockatrice/) [](https://www.transifex.com/projects/p/cockatrice/resource/oracle/)
|
|
|
|
Check out our [Translator FAQ](https://github.com/Cockatrice/Cockatrice/wiki/Translation-FAQ) for more information!
|
|
|
|
# Building [](https://travis-ci.org/Cockatrice/Cockatrice)
|
|
|
|
**Detailed installation instructions are on the Cockatrice wiki under [Installing Cockatrice](https://github.com/Cockatrice/Cockatrice/wiki/Installing-Cockatrice)**
|
|
|
|
Dependencies:
|
|
|
|
- [Qt](http://qt-project.org/)
|
|
- [protobuf](http://code.google.com/p/protobuf/)
|
|
- [CMake](http://www.cmake.org/)
|
|
|
|
Oracle can optionally use zlib to load zipped files:
|
|
|
|
- [zlib](http://www.zlib.net/)
|
|
|
|
The server requires an additional dependency when compiled under Qt4:
|
|
|
|
- [libgcrypt](http://www.gnu.org/software/libgcrypt/)
|
|
|
|
To compile:
|
|
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
make install
|
|
|
|
The following flags can be passed to `cmake`:
|
|
|
|
- `-DWITH_SERVER=1` Build the server
|
|
- `-DWITH_CLIENT=0` Do not build the client
|
|
- `-DWITH_ORACLE=0` Do not build Oracle
|
|
- `-DWITH_QT4=1` Force compilation to use Qt4 instead of Qt5.
|
|
- `-DCMAKE_BUILD_TYPE=Debug` Compile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings.
|
|
- `-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. You should run this when contributing code that changes user messages. Translation file updates should be added in the same commit as the string that was changed.
|
|
|
|
# Running
|
|
|
|
`oracle` fetches card data
|
|
`cockatrice` is the game client
|
|
`servatrice` is the server
|
|
|
|
# License
|
|
|
|
Cockatrice is free software, licensed under the GPLv2; see COPYING for details.
|