ddnet/README.md

Our own flavor of DDRace, a Teeworlds mod. See the website for more information.

Development discussions happen on #ddnet on Quakenet (Webchat) or on Discord in the developer channel.

You can get binary releases on the DDNet website.

Cloning

To clone this repository with full history and external libraries (~350 MB):

git clone --recursive https://github.com/ddnet/ddnet

To clone this repository with full history when you have the necessary libraries on your system already (~220 MB):

git clone https://github.com/ddnet/ddnet

To clone this repository with history since we moved the libraries to https://github.com/ddnet/ddnet-libs (~40 MB):

git clone --shallow-exclude=included-libs https://github.com/ddnet/ddnet

To clone the libraries if you have previously cloned DDNet without them:

git submodule update --init --recursive

Building on Linux and macOS

To compile DDNet yourself, execute the following commands in the source root:

mkdir build
cd build
cmake ..
make

DDNet requires additional libraries, that are bundled for the most common platforms (Windows, Mac, Linux, all x86 and x86_64). The bundled libraries are now in the ddnet-libs submodule.

You can install the required libraries on your system, touch CMakeLists.txt and CMake will use the system-wide libraries by default. You can install all required dependencies and CMake on Debian or Ubuntu like this:

sudo apt install cmake git libcurl4-openssl-dev libfreetype6-dev libglew-dev libogg-dev libopus-dev libopusfile-dev libpnglite-dev libsdl2-dev libwavpack-dev python

Or on Arch Linux like this (Arch Linux does not package pnglite, not even in AUR):

sudo pacman -S --needed cmake curl freetype2 git glew opusfile sdl2 wavpack python

The following is a non-exhaustive list of build arguments that can be appended to the cmake command-line tool in order to enable or disable options in build time:

• -DCMAKE_BUILD_TYPE=[Release|Debug|RelWithDebInfo|MinSizeRel]
  An optional CMake variable for setting the build type. If not set, defaults to "Release" if -DDEV=ON is not used, and "Debug" if -DDEV=ON is used. See CMAKE_BUILD_TYPE in CMake Documentation for more information.

• -DPREFER_BUNDLED_LIBS=[ON|OFF]
  Enables/disables preference for bundled libraries over system libraries. Setting to ON will make DDNet use third party libraries available in the ddnet-libs folder, which is the git-submodule target of the ddnet-libs repository mentioned above. Useful if you do not have those libraries installed and want to avoid building them. Default value is OFF.

• -DWEBSOCKETS=[ON|OFF]
  Enables/disables WebSocket support for server. Setting to ON requires the libwebsockets-dev library installed. Default value is OFF.

• -DMYSQL=[ON|OFF]
  Enables/disables MySQL (or MariaDB) support for server. Setting to ON requires the libmariadbclient-dev, libmysqlcppconn-dev and libboost-dev libraries installed, which are also provided as bundled libraries for the common platforms. Default value is OFF.

  Note that the bundled MySQL libraries might not work properly on your system. If you run into connection problems with the MySQL server, for example that it connects as root while you chose another user, make sure to install your system libraries for the MySQL client and C++ connector. Make sure that the CMake configuration summary says that it found MySQL libs that were not bundled (no "using bundled libs").

• -DAUTOUPDATE=[ON|OFF]
  Enables/disables the autoupdater. Packagers may want to disable this for their packages. Default value is ON for Windows and Linux.

• -DCLIENT=[ON|OFF]
  Enables/disables client compilation. If set to OFF, DDNet will not depend on Curl, Freetype, Ogg, Opus, Opusfile, and SDL2. Default value is ON.

• -DDOWNLOAD_GTEST=[ON|OFF]
  Enables/disables download and compilation of GTest. Useful if GTest is not installed and, for Linux users, there is no suitable package providing it. Default value is OFF.

• -DDEV=[ON|OFF]
  Enables/disables generation of stuff necessary for packaging. Setting to ON will set CMAKE_BUILD_TYPE to Debug by default. Default value is OFF.

Running tests (Debian/Ubuntu)

In order to run the tests, you need to install the following library libgtest-dev.

This library isn't compiled, so you have to do it:

sudo apt install libgtest-dev
cd /usr/src/gtest
sudo cmake CMakeLists.txt
sudo make
 
# copy or symlink libgtest.a and libgtest_main.a to your /usr/lib folder
sudo cp *.a /usr/lib

To run the tests you must target run_tests with make: make run_tests

Building on Windows with Visual Studio

Download and install some version of Microsoft Visual Studio (as of writing, MSVS Community 2017) with C++ support, install Python 3 for all users and install CMake.

Start CMake and select the source code folder (where DDNet resides, the directory with CMakeLists.txt). Additionally select a build folder, e.g. create a build subdirectory in the source code directory. Click "Configure" and select the Visual Studio generator (it should be pre-selected, so pressing "Finish" will suffice). After configuration finishes and the "Generate" reactivates, click it. When that finishes, click "Open Project". Visual Studio should open. You can compile the DDNet client by right-clicking the DDNet project (not the solution) and select "Select as StartUp project". Now you should be able to compile DDNet by clicking the green, triangular "Run" button.

Cross-compiling on Linux to Windows x86/x86_64

Install MinGW cross-compilers of the form i686-w64-mingw32-gcc (32 bit) or x86_64-w64-mingw32-gcc (64 bit). This is probably the hard part. ;)

Then add -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/mingw64.toolchain to the initial CMake command line.

Cross-compiling on Linux to macOS

Install osxcross, then add -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/darwin.toolchain and -DCMAKE_OSX_SYSROOT=/path/to/osxcross/target/SDK/MacOSX10.11.sdk/ to the initial CMake command line.

Install dmg and hfsplus from libdmg-hfsplus and newfs_hfs from diskdev_cmds to unlock the package_dmg target that outputs a macOS disk image.

Importing the official DDNet Database

$ wget https://ddnet.tw/stats/ddnet-sql.zip
$ unzip ddnet-sql.zip
$ yaourt -S mariadb mysql-connector-c++
$ mysql_install_db --user=mysql --basedir=/usr --datadir=/var/lib/mysql
$ systemctl start mariadb
$ mysqladmin -u root password 'PW'
$ mysql -u root -p'PW'
MariaDB [(none)]> create database teeworlds; create user 'teeworlds'@'localhost' identified by 'PW2'; grant all privileges on teeworlds.* to 'teeworlds'@'localhost'; flush privileges;
# this takes a while, you can remove the KEYs in record_race.sql to trade performance in queries
$ mysql -u teeworlds -p'PW2' teeworlds < ddnet-sql/record_*.sql

$ cat mine.cfg
sv_use_sql 1
add_sqlserver r teeworlds record teeworlds "PW2" "localhost" "3306"
add_sqlserver w teeworlds record teeworlds "PW2" "localhost" "3306"

$ mkdir build
$ cd build
$ cmake -DMYSQL=ON ..
$ make
$ ./DDNet-Server -f mine.cfg

Repository status