README.md

   1 NetRadiant
   2 ==========
   3
   4 The open source, cross platform level editor for idtech games (NetRadiant fork)
   5
   6 # Getting the Sources
   7
   8 The latest source is available from the git repository:
   9 https://gitlab.com/xonotic/netradiant.git
  10
  11 The git client can be obtained from the Git website:
  12 http://git-scm.org
  13
  14 To get a copy of the source using the commandline git client:
  15 ```
  16 git clone https://gitlab.com/xonotic/netradiant.git
  17 cd netradiant
  18 ```
  19
  20 See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and more.
  21
  22 # Dependencies
  23
  24  * OpenGL
  25  * LibXml2
  26  * GTK2
  27  * GtkGLExt
  28  * LibJpeg
  29  * LibPng
  30  * ZLib
  31
  32 # Compiling
  33
  34 This project uses the usual CMake workflow:
  35
  36     mkdir build && cd build && cmake .. && cmake --build .
  37
  38 ## linux
  39
  40 ```
  41 cmake -G "Unix Makefiles" ..
  42 cmake --build . -- -j$(nproc)
  43 ```
  44
  45 ## msys2
  46
  47 `pacman -S --needed base-devel`
  48
  49 ### 32 bit:
  50
  51 ```
  52 pacman -S --needed mingw-w64-i686-{toolchain,cmake,gtk2,gtkglext}
  53 mkdir build && cd build
  54 cmake -G "MSYS Makefiles" .. -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw32/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw32/lib/gtk-2.0/include
  55 cmake --build . -- -j$(nproc)
  56 ```
  57
  58 ### 64 bit:
  59
  60 ```
  61 pacman -S mingw-w64-x86_64-{toolchain,cmake,gtk2,gtkglext}
  62 mkdir build && cd build
  63 cmake -G "MSYS Makefiles" .. -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw64/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw64/lib/gtk-2.0/include
  64 cmake --build . -- -j$(nproc)
  65 ```
  66
  67 ## OS X:
  68
  69 ```
  70 brew install gtkglext
  71 brew install Caskroom/cask/xquartz
  72 brew link --force gettext
  73 ```
  74
  75 More Compilation Details
  76 ------------------------
  77
  78 options:
  79  * `DOWNLOAD_GAMEPACKS=ON`
  80    Automatically download the gamepack data during the first compilation
  81  * `RADIANT_ABOUTMSG="Custom build"`
  82    A message shown in the about dialog
  83
  84 targets:
  85  * `radiant`    Compiles the radiant core binary
  86  * `modules`    Compiles all modules (each module has its own target as well)
  87  * `plugins`    Compiles all plugins (each plugin has its own target as well)
  88  * `game_packs` Downloads the game pack data
  89  * `quake3`     Compiles all the Quake3 tools
  90    - `q3map2`     Quake3 map compiler
  91    - `q3data`
  92  * `quake2`     Compiles all the Quake2 tools (Note: needs to be compiled explicitly)
  93    - `q2map`      Quake2 map compiler
  94    - `q2data`
  95    - `h2data`