Leahnaya/Cockatrice

Fork 0

mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-08-11 11:35:44 -05:00

Table of Contents

Compiling On Linux

Note

Packages
Dependencies

Minimum Requirements
Dependency Lists by Distribution

Arch Linux and Arch-based distros
Debian and Debian-based distros
Fedora and Fedora-based distros
Gentoo

Compiling

CMake options
Compiling

Installing

Using Cpack
Other systems

Troubleshooting

Warnings in debug builds
Debug logging on Fedora
Memory shortages on Raspberry Pi
Using Windows Subsystem for Linux

← Back to Compiling Overview

Compiling On Linux

Precompiled Packages
Installing Dependencies
Compiling
Installation
Troubleshooting

Note

All command lines indicated by $ are to be run as a normal user, while # requires root privilege, for example by prefacing it with sudo or executing through sudo sh -c 'command' or su -c 'command'.

Packages

We provide packages for some distros on our release page. You can install these packages with your package manager or a tool like Eddy. Make sure the package name matches the specific version of your operating system.

to install a downloaded package on a debian based system for example you can open a terminal at the location that you downloaded the package to and use sudo apt install ./Cockatrice*.deb

Some distros already include packages for cockatrice in their repositories, see Unofficial Developer Builds.

Dependencies

In order to compile Cockatrice we recommend installing the following tools. Please ensure you meet the general minimum requirements and have the correct dependencies installed for your distribution.

Minimum Requirements

C++ compiler w/ C++17 support (eg. GCC 8 or Newer)
CMake 3.16 or Newer
Protobuf 3.0 or Newer
Qt 6.4.2 or Newer with components qtmultimedia and qtwebsockets

Conditional requirements:

mysql or mariadb (only for running a server database)
if using mysql the qt sql connector for C++ is required
liblzma (recommended for oracle)

Dependency Lists by Distribution

Arch Linux and Arch-based distros

(Manjaro and EndeavourOS are based on Arch Linux)

# pacman --sync --needed \
    cmake \
    gcc \
    git \
    make \
    mariadb-libs \
    protobuf \
    qt6-base \
    qt6-multimedia \
    qt6-svg \
    qt6-tools \
    qt6-translations \
    qt6-websockets \
    zlib

Debian and Debian-based distros

(Ubuntu, Linux Mint, Pop!_OS, and KDE Neon are based on Debian)

# apt install \
        build-essential \
        ccache \
        clang-format \
        cmake \
        file \
        g++ \
        git \
        libgl-dev \
        liblzma-dev \
        libmariadb-dev-compat \
        libprotobuf-dev \
        libqt6multimedia6 \
        libqt6sql6-mysql \
        protobuf-compiler \
        qt6-l10n-tools \
        qt6-multimedia-dev \
        qt6-svg-dev \
        qt6-tools-dev \
        qt6-tools-dev-tools \
        qt6-websockets-dev

Fedora and Fedora-based distros

(RHEL, Asahi Linux, and Nobara are based on Fedora)

# dnf install \
    @development-tools \
    cmake \
    desktop-file-utils \
    gcc-c++ \
    hicolor-icon-theme \
    libappstream-glib \
    mariadb-devel \
    protobuf-devel \
    qt6-{qttools,qtsvg,qtmultimedia,qtwebsockets}-devel \
    wget \
    xz-devel \
    zlib-devel

Gentoo

# emerge -av \
    protobuf \
    qt{base,tools,svg,multimedia,websockets}:6

In case your distribution is not listed above you can try to find these components yourself. Make sure the packages you install meet our version requirements. You might have to compile these components from their sources if no suitable packages are available, please refer to their respective documentation for information on how to do so.

Compiling

Get a copy of Cockatrice's source code:

$ git clone https://github.com/Cockatrice/Cockatrice
$ cd Cockatrice

Create a directory to host the build process:

$ mkdir build
$ cd build

Run cmake to configure the build:

$ cmake ..

CMake options

When configuring you can select multiple options, by default Cockatrice will only select the tools needed to run the client, in order to compile the server you should add the following option to the cmake command:

$ cmake .. -DWITH_SERVER=1

Alternatively, if you want to create a debug build as a developer or to troubleshoot issues:

$ cmake .. -DWITH_SERVER=1 -DCMAKE_BUILD_TYPE=Debug -DTEST=1

We use googletest in our tests, if you enable them the components will be downloaded to your build dir, alternatively you can install googletest separately

In order to compile only the server you can exclude the client components:

$ cmake .. -DWITH_SERVER=1 -DWITH_CLIENT=0 -DWITH_ORACLE=0

Compiling

You can now start compiling, you can configure the amount of cpu cores used, the recommended amount is the total amount of threads available to the system minus one.

$ cmake --build . --parallel7

Alternatively you can use nice to have the compiler be nicer to your system resources:

$ nice make -j

Installing

Using Cpack

On debian or fedora based systems you can create a .deb or .rpm package like this:

$ make package

At last, install the package:

# dpkg -i ./Cockatrice*.deb  # for debian packages
# dnf --install ./Cockatrice*.rpm  # for rpm packages

Other systems

Alternatively, you can install Cockatrice directly:

# make install

Cockatrice does not provide an uninstall target, when running install cmake will create a file named install_manifest.txt, in order to completely uninstall you'll want to remove all files listed there (issue ticket)

Troubleshooting

Warnings in debug builds

If you're using an older version of protobuf you might have warnings in protobuf be caught as errors in your debug build, add this flag to cmake to prevent this from stopping the build: -DWARNING_AS_ERROR=0

Debug logging on Fedora

Some of the debug logging functionality (qDebug() output) of the Debug builds (-DCMAKE_BUILD_TYPE=Debug) may not work immediately with Fedora. Qt logging is turned off system-wide, but can be enabled by creating a qtlogging.ini file at ~/.config/QtProject/qtlogging.ini, and adding the following rules into it:

[Rules]
*.debug=true
qt.*.debug=false

https://brendanwhitfield.wordpress.com/2016/06/08/enabling-qdebug-on-fedora/

https://ask.fedoraproject.org/en/question/87522/qt-56-qdebug-and-qlog-no-longer-work/

Memory shortages on Raspberry Pi

Due to the amount of memory that is required in order to compile the application you will also need to make sure you have at least 2GB of swap space configured. If you are unfamiliar with how to increase your swap file size on the Raspberry Pi one decent article available is located at http://raspberrypimaker.com/adding-swap-to-the-raspberrypi.

The cards database has grown lately and Oracle might need more memory. So to be sure to correctly update your database, you need more swap on your Raspberry. Follow the following steps to use a dynamic swapfile that will grow when needed:

1- Edit the /etc/dphys-swapfile

$ sudo nano /etc/dphys-swapfile

2- Uncomment the CONF_SWAPFILE=/var/swap line.
3- Uncomment the CONF_SWAPFACTOR=2 line.
4- Check that the CONF_SWAPSIZE=100 line stays commented.
5- Restart the swap process.

$ sudo /etc/init.d/dphys-swapfile restart

Once installation has completed, it is recommended to restart your Raspberry Pi. This will allow for the X Windows manager to shutdown properly and upon restart add the Cockatrice application shortcut to the Games menu.

Using Windows Subsystem for Linux

One final note: If you're building for Linux using WSL (Windows Subsystem for Linux) you'll need to install an X Server to be able to actually run the program. One option is Xming. Since Windows 11 this might not be necessary anymore.

TODO:

trim down package requirements to minimum

should we provide instructions for centos?

instructions on how to make appimages?

Welcome to the Cockatrice Wiki

Technical

Customizing Cockatrice

Servatrice Server

Helping Cockatrice

Feel free to contact and connect with us on Discord and Reddit!