Trainfng is a Teeworlds mod created from ddnet. The aim of this mod is to be able to train easily to the fng mod.
To clone this repository with full history and external libraries (~350 MB):
git clone --recursive https://github.com/35niavlys/teeworlds-trainfng
To clone this repository with full history when you have the necessary libraries on your system already (~220 MB):
git clone https://github.com/35niavlys/teeworlds-trainfng
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/35niavlys/teeworlds-trainfng
To clone the libraries if you have previously cloned DDNet without them:
git submodule update --init --recursive
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 build-essential cmake git google-mock libcurl4-openssl-dev libssl-dev libfreetype6-dev libglew-dev libnotify-dev libogg-dev libopus-dev libopusfile-dev libsdl2-dev libsqlite3-dev libwavpack-dev python libx264-dev libavfilter-dev libavdevice-dev libavformat-dev libavcodec-extra libavutil-dev libvulkan-dev glslang-tools spirv-tools libpng-dev
On older distributions like Ubuntu 18.04 don't install google-mock
, but instead set -DDOWNLOAD_GTEST=ON
when building to get a more recent gtest/gmock version.
Or on CentOS, RedHat and AlmaLinux like this:
sudo yum install gcc gcc-c++ make cmake git python2 gtest-devel gmock-devel libcurl-devel openssl-devel freetype-devel glew-devel libnotify-devel libogg-devel opus-devel opusfile-devel SDL2-devel sqlite-devel wavpack-devel libx264-devel ffmpeg-devel vulkan-devel glslang spirv-tools libpng-devel
Or on Arch Linux like this:
sudo pacman -S --needed base-devel cmake curl freetype2 git glew gmock libnotify opusfile python sdl2 sqlite wavpack x264 ffmpeg vulkan-icd-loader vulkan-headers glslang spirv-tools libpng
On macOS you can use homebrew to install build dependencies like this:
brew install cmake freetype glew googletest opusfile SDL2 wavpack x264 ffmpeg molten-vk vulkan-headers glslang spirv-tools libpng
If you don't want to use the system libraries, you can pass the -DPREFER_BUNDLED_LIBS=ON
parameter to cmake.
To compile DDNet yourself, execute the following commands in the source root:
mkdir build
cd build
cmake ..
make -j$(nproc)
Pass the number of threads for compilation to make -j
. $(nproc)
in this case returns the number of processing units.
DDNet requires additional libraries, some of which are bundled for the most common platforms (Windows, Mac, Linux, all x86 and x86_64) for convenience and the official builds. The bundled libraries for official builds are now in the ddnet-libs submodule. Note that when you build and develop locally, you should ideally use your system's package manager to install the dependencies, instead of relying on ddnet-libs submodule, which does not contain all dependencies anyway (e.g. openssl, vulkan). See the previous section for how to get the dependencies. Alternatively see the following build arguments for how to disable some features and their dependencies (-DVULKAN=OFF
won't require Vulkan for example).
The following is a non-exhaustive list of build arguments that can be passed 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. SeeCMAKE_BUILD_TYPE
in CMake Documentation for more information. -
-DPREFER_BUNDLED_LIBS=[ON|OFF]
Whether to prefer bundled libraries over system libraries. Setting to ON will make DDNet use third party libraries available in theddnet-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. If set to OFF, will only use bundled libraries when system libraries are not found. Default value is OFF. -
-DWEBSOCKETS=[ON|OFF]
Whether to enable WebSocket support for server. Setting to ON requires thelibwebsockets-dev
library installed. Default value is OFF. -
-DMYSQL=[ON|OFF]
Whether to enable MySQL/MariaDB support for server. Requires at least MySQL 8.0 or MariaDB 10.2. Setting to ON requires thelibmariadbclient-dev
library 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. Make sure that the CMake configuration summary says that it found MySQL libs that were not bundled (no "using bundled libs").
-
-DTEST_MYSQL=[ON|OFF]
Whether to test MySQL/MariaDB support in GTest based tests. Note that this requires a running MySQL/MariaDB database on localhost with this setup:
CREATE DATABASE ddnet;
CREATE USER 'ddnet'@'localhost' IDENTIFIED BY 'thebestpassword';
GRANT ALL PRIVILEGES ON ddnet.* TO 'ddnet'@'localhost';
FLUSH PRIVILEGES;
-
-DAUTOUPDATE=[ON|OFF]
Whether to enable the autoupdater. Packagers may want to disable this for their packages. Default value is ON for Windows and Linux. -
-DCLIENT=[ON|OFF]
Whether to enable client compilation. If set to OFF, DDNet will not depend on Curl, Freetype, Ogg, Opus, Opusfile, and SDL2. Default value is ON. -
-DVIDEORECORDER=[ON|OFF]
Whether to add video recording support using FFmpeg to the client. Default value is ON. -
-DDOWNLOAD_GTEST=[ON|OFF]
Whether to download and compile 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]
Whether to optimize for development, speeding up the compilation process a little. If enabled, don't generate stuff necessary for packaging. Setting to ON will set CMAKE_BUILD_TYPE to Debug by default. Default value is OFF. -
-DUPNP=[ON|OFF]
Whether to enable UPnP support for the server. You need to installlibminiupnpc-dev
on Debian,miniupnpc
on Arch Linux. -
-DVULKAN=[ON|OFF]
Whether to enable the vulkan backend. On Windows you need to install the Vulkan SDK and set theVULKAN_SDK
environment flag accordingly. -
-GNinja
Use the Ninja build system instead of Make. This automatically parallizes the build and is generally faster. Compile withninja
instead ofmake
. Install Ninja withsudo apt install ninja-build
on Debian,sudo pacman -S --needed ninja
on Arch Linux. -
-DCMAKE_CXX_LINK_FLAGS=[FLAGS]
Custom flags to set for compiler when linking. With clang++ as the compiler this can be used to link with mold, speeds up linking by a factor of ~10:
CC=clang CXX=clang++ cmake -DCMAKE_CXX_LINK_FLAGS="--ld-path=/usr/bin/mold" .
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 -j8
# copy or symlink libgtest.a and libgtest_main.a to your /usr/lib folder
sudo cp lib/*.a /usr/lib
To run the tests you must target run_tests
with make:
make run_tests
We use clang-format 10 to format the C++ code of this project. Execute scripts/fix_style.py
after changing the code to ensure code is formatted properly, a GitHub central style checker will do the same and prevent your change from being submitted.
On Arch Linux you can install clang-format 10 using the clang-format-static-bin AUR package. On macOS you can install clang-format 10 using a homebrew tap:
brew install r-lib/taps/clang-format@10
sudo ln -s /opt/homebrew/Cellar/clang-format@10/10.0.1/bin/clang-format /opt/homebrew/bin/clang-format-10
ASan+UBSan and Memcheck are useful to find code problems more easily. Please use them to test your changes if you can.
For ASan+UBSan compile with:
CC=clang CXX=clang++ CXXFLAGS="-fsanitize=address,undefined -fsanitize-recover=address,undefined -fno-omit-frame-pointer" CFLAGS="-fsanitize=address,undefined -fsanitize-recover=address,undefined -fno-omit-frame-pointer" cmake -DCMAKE_BUILD_TYPE=Debug .
make
and run with:
UBSAN_OPTIONS=suppressions=./ubsan.supp:log_path=./SAN:print_stacktrace=1:halt_on_errors=0 ASAN_OPTIONS=log_path=./SAN:print_stacktrace=1:check_initialization_order=1:detect_leaks=1:halt_on_errors=0 LSAN_OPTIONS=suppressions=./lsan.supp ./DDNet
Check the SAN.* files afterwards. This finds more problems than memcheck, runs faster, but requires a modern GCC/Clang compiler.
For valgrind's memcheck compile a normal Debug build and run with: valgrind --tool=memcheck ./DDNet
Expect a large slow down.
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.
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.
Install Emscripten cross-compilers (e.g. sudo apt install emscripten
) on a modern linux distro.
If you need to compile the ddnet-libs for WebAssembly, simply call
# <directory to build in> should be a directory outside of the project's source directory
scripts/compile_libs/gen_libs.sh <directory to build in> webasm
from the project's source directory. It will automatically create a directory called ddnet-libs
.
You can then manually merge this directory with the one in the ddnet source directory.
Then run emcmake cmake .. -DVIDEORECORDER=OFF -DVULKAN=OFF -DSERVER=OFF -DTOOLS=OFF -DPREFER_BUNDLED_LIBS=ON
in your build directory.
To test the compiled code locally, just use emrun --browser firefox DDNet.html
To host the compiled .html file copy all .data
, .html
, .js
, .wasm
files to the web server. (see /other/emscripten/minimal.html for a minimal html example)
Then enable cross origin policies. Example for apache2 on debian based distros:
sudo a2enmod header
# edit the apache2 config to allow .htaccess files
sudo nano /etc/apache2/apache2.conf
# set AllowOverride to All for your directory
# then create a .htaccess file on the web server (where the .html is)
# and add these lines
Header add Cross-Origin-Embedder-Policy "require-corp"
Header add Cross-Origin-Opener-Policy "same-origin"
# now restart apache2
sudo service apache2 restart
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.
$ 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 -j8
$ ./TrainFNG-Server -f mine.cfg
Debian/Ubuntu
$ apt-get install ddnet
MacOS
$ brew cask install ddnet
Fedora
$ dnf install ddnet
Arch Linux
$ yay -S ddnet