ddnet/README.md
2017-08-29 11:26:24 +02:00

5.1 KiB

DDraceNetwork CircleCI Build Status Travis CI Build Status AppVeyor Build Status

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, you can follow the instructions for compiling Teeworlds. Alternatively we also support CMake, so something like this works:

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, remove the config.lua and bam should use the system-wide libraries by default. You can install all required dependencies and bam on Debian and Ubuntu like this:

apt-get install libsdl2-dev libfreetype6-dev libcurl4-openssl-dev libogg-dev libopus-dev libopusfile-dev bam cmake

Or on Arch Linux like this:

pacman -S sdl2 freetype2 curl opusfile bam cmake

If you have the libraries installed, but still want to use the bundled ones instead, you can specify so by running bam config curl.use_pkgconfig=false opus.use_pkgconfig=false opusfile.use_pkgconfig=false ogg.use_pkgconfig=false.

The MySQL server is not included in the binary releases and can be built with bam server_sql_release. It requires libmariadbclient-dev, libmysqlcppconn-dev and libboost-dev, which are also bundled for the common platforms.

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 mysql.use_mysqlconfig is set to true in your config.lua.

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.

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"

$ bam server_sql_release
$ ./DDNet-Server_sql -f mine.cfg