BUILDING.md

   1 # Building instructions
   2
   3 CMake is used for compiling. Make sure to clone the repository recursively:
   4
   5 ```bash
   6 git clone --recurse-submodules https://github.com/dragonblocks/dragonblocks_alpha.git
   7 ```
   8
   9 ## Dependencies
  10 To build anything you need CMake. The ZLib development library is needed as well.
  11 The development versions of OpenGL, GLFW3, GLEW and Freetype are required to build the client.
  12 For building the server the SQLite3 development library is required.
  13
  14
  15 Ubuntu / Debian:
  16
  17 ```bash
  18 sudo apt install build-essential cmake zlib1g-dev libgl1-mesa-dev libglfw3-dev libglew-dev libfreetype-dev libsqlite3-dev
  19 ```
  20
  21 FreeBSD:
  22
  23 ```csh
  24 sudo pkg install cmake gcc lzlib mesa-devel glfw glew freetype sqlite3
  25 ```
  26
  27 OpenBSD:
  28
  29 ```sh
  30 sudo pkg_add cmake lzlib glfw glew freetype sqlite3
  31 ```
  32
  33 ## Building a debug build
  34 By default CMake will make a Debug build if nothing else is specified. Simply use
  35
  36 ```bash
  37 cd src
  38 cmake .
  39 make -j$(nproc)
  40 ```
  41
  42 to build the dragonblocks client and server.
  43 If you use a debug build, the singleplayer script should be invoked from the src/ directory, because that's where the binaries are located.
  44
  45 ## Building a snapshot
  46
  47 ```bash
  48 ./snapshot.sh
  49 ```
  50 This script will create a snapshot zipfile.