BUILDING.md

   1 # Building instructions
   2
   3 ## Dependencies
   4 To build anything you need Git, CMake, Lua, Bash and GCC. Make sure these dependencies are installed on your system.
   5 All other dependencies are included as submodules, compiled automatically and statically linked.
   6 Make sure to clone the repository recursively:
   7
   8 ```bash
   9 git clone --recurse-submodules https://github.com/dragonblocks/dragonblocks_alpha.git
  10 ```
  11
  12 ## Building a debug build
  13 By default CMake will make a debug build if nothing else is specified. Simply use
  14
  15 ```bash
  16 cmake -B build -S src
  17 cd build
  18 make -j$(nproc)
  19 ```
  20
  21 to build the dragonblocks client and server.
  22 If you use a debug build, the singleplayer script should be invoked from the build/ directory, because that's where the binaries are located.
  23
  24 ## Building a release snapshot
  25
  26 ```bash
  27 # Native snapshot
  28 ./snapshot.sh
  29
  30 # Crosscompiling for windows (requires i686-w64-mingw32-gcc-posix)
  31 ./snapshot.sh mingw
  32 ```
  33
  34 Creates snapshot zipfiles.