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
  12 ```bash
  13 sudo apt install build-essential cmake zlib1g-dev
  14 ```
  15
  16 The development versions of OpenGL, GLFW3, GLEW and Freetype are required to build the client.
  17
  18 ```bash
  19 sudo apt install libgl1-mesa-dev libglfw3-dev libglew-dev libfreetype-dev
  20 ```
  21
  22 For building the server the SQLite3 development library is required.
  23
  24 ```bash
  25 sudo apt install libsqlite3-dev
  26 ```
  27
  28 ## Building a debug build
  29 By default CMake will make a Debug build if nothing else is specified. Simply use
  30
  31 ```bash
  32 cd src
  33 cmake .
  34 make -j$(nproc)
  35 ```
  36
  37 to build the dragonblocks client and server.
  38 If you use a debug build, the singleplayer script should be invoked from the src/ directory, because that's where the binaries are located.
  39
  40 ## Building a snapshot
  41
  42 ```bash
  43 ./snapshot.sh
  44 ```
  45 This script will create a snapshot zipfile.