README.md

   1 NetRadiant
   2 ==========
   3
   4 [![NetRadiant logo](setup/data/tools/bitmaps/splash.png)](https://netradiant.gitlab.io)
   5
   6 The open source, cross platform level editor for id Tech-derivated games, heir of GtkRadiant.
   7
   8 Learn more on NetRadiant website: [netradiant.gitlab.io](https://netradiant.gitlab.io).
   9
  10
  11 ## Download NetRadiant
  12
  13 Prebuilt binaries can be found on the [Download page](https://netradiant.gitlab.io/page/download/).
  14
  15
  16 ## Compatibility matrix
  17
  18 |System   |Build    |Bundle    |Run      |Build requirements                            |
  19 |---------|---------|----------|---------|----------------------------------------------|
  20 |Linux    |**Yes**  |**Yes**   |**Yes**  |_GCC or Clang_                                |
  21 |FreeBSD  |**Yes**  |**Yes**   |**Yes**  |_GCC or Clang_                                |
  22 |Windows  |**Yes**  |**Yes**   |**Yes**  |_MSYS2/Mingw64 or Mingw32_                    |
  23 |Wine     |-        |-         |**Yes**  |-                                             |
  24 |macOS    |**Yes**  |**Yes**   |**Yes**  |_Homebrew, GCC or Clang and builtin GtkGLExt_ |
  25
  26 NetRadiant is known to build and run properly on Linux, FreeBSD and Windows using MSYS2, and build on macOS with Homebrew (some bugs are known though). Windows build is known to work well on wine, which can be used as a fallback on some system.
  27
  28 At this time library bundling is supported on Linux, FreeBSD, Windows/MSYS2, and macOS/Homebrew. Since bundling copies things from the host, a clean build environment has to be used in order to get a clean bundle. Linux and FreeBSD bundles do not ship GTK: users are expected to have a working GTK environment with GtkGLExt installed, usually installing GtkGLExt is enough to pull everything that is required.
  29
  30
  31 ## Getting the sources
  32
  33 Source browser, issues and more can be found on the gitlab project: [gitlab.com/xonotic/netradiant](https://gitlab.com/xonotic/netradiant)
  34
  35 The latest source is available from the git repository: `https://gitlab.com/xonotic/netradiant.git`
  36
  37 The `git` client can be obtained from your distribution repository or from the Git website: [git-scm.org](http://git-scm.org)
  38
  39 A copy of the source tree can be obtained by using the `git` command line client this way:
  40
  41 ```sh
  42 git clone --recursive https://gitlab.com/xonotic/netradiant.git
  43 cd netradiant
  44 ```
  45
  46
  47 ## Dependencies
  48
  49 * OpenGL, LibXml2, GTK2, GtkGLExt, LibJpeg, LibPng, LibWebp, Minizip, ZLib.
  50
  51 To fetch default game packages you'll need Git, Subversion, Wget and `unzip`.
  52
  53
  54 ### Ubuntu:
  55
  56 ```sh
  57 apt-get install --reinstall build-essential cmake \
  58     lib{x11,gtk2.0,gtkglext1,xml2,jpeg,webp,minizip}-dev \
  59     git subversion unzip wget
  60 ```
  61
  62 If you plan to build a bundle, you also need to install `uuid-runtime patchelf`
  63
  64 This is enough to build NetRadiant but you may also install those extra packages to get proper GTK2 graphical and sound themes: `gnome-themes-extra gtk2-engines-murrine libcanberra-gtk-module`
  65
  66
  67 ### MSYS2:
  68
  69 Under MSYS2, the mingw shell must be used.
  70
  71 If you use MSYS2 over SSH, add `mingw64` to the path this way (given you compile for 64 bit Windows, replace with `mingw32` if you target 32 bit Windows instead):
  72
  73 ```sh
  74 export PATH="/mingw64/bin:${PATH}"
  75 ```
  76
  77 Install the dependencies this way:
  78
  79 ```sh
  80 pacman -S --needed base-devel git \
  81     mingw-w64-$(uname -m)-{ntldd-git,subversion,unzip,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git}
  82 ```
  83
  84 Explicitely use `mingw-w64-x86_64-` or `mingw-w64-i686-` prefix instead of `mingw-w64-$(uname -m)` if you need to target a non-default architecture.
  85
  86
  87 ### FreeBSD:
  88
  89 ```sh
  90 pkg install cmake gtkglext pkgconf minizip webp coreutils gsed git subversion wget unzip
  91 ```
  92
  93 If you plan to build a bundle, you also need to install `patchelf`
  94
  95
  96 ### macOS:
  97
  98 ```sh
  99 brew install cmake glib gtk+ pkgconfig minizip webp coreutils gnu-sed wget
 100 brew link --force gettext
 101 ```
 102
 103
 104 ## Submodules
 105
 106  * Crunch (optional, not built if submodule is not present)
 107
 108 If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run this within the `netradiant` repository):
 109
 110 ```sh
 111 git submodule update --init --recursive
 112 ```
 113
 114
 115 ## Simple compilation
 116
 117 It is required to first download the sources using `git` (do not use tarballs) and to have dependencies installed, see [Getting the sources](#getting-the-sources) and [Dependencies](#dependencies) above.
 118
 119
 120 ### Easy builder assistant
 121
 122 If you have standard needs and use well-known platform and operating system, you may try the provided `easy-builder` script which may be enough for you, you can run it this way:
 123
 124 ```sh
 125 ./easy-builder
 126 ```
 127
 128 If everything went right, you'll find your netradiant build in `install/` subdirectory.
 129
 130 If you need to build a debug build (to get help from a developer, for example), you can do it this way:
 131
 132 ```sh
 133 ./easy-builder --debug
 134 ```
 135
 136 By default, build tools and compilers are using the `build/` directory as workspace.
 137
 138 For supported system, bundling dependencies can be done this way:
 139
 140 ```sh
 141 ./easy-builder -DBUNDLE_LIBRARIES=ON
 142 ```
 143
 144 Note: always do bundling on a clean system without unrelated software installed.
 145
 146
 147 ## Advanced compilation
 148
 149 ### Initial build
 150
 151 This project uses the usual CMake workflow:
 152
 153
 154 #### Debug build
 155
 156 ```sh
 157 cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug
 158 cmake --build build -- -j$(nproc)
 159 ```
 160
 161
 162 #### Release build
 163
 164 ```sh
 165 cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
 166 cmake --build build -- -j$(nproc)
 167 ```
 168
 169 Note: macOS users need to build built-in GtkGLExt before building NetRadiant:
 170
 171 ```sh
 172 cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
 173 cmake --build build -- -j$(nproc) builtins
 174 cmake -G "Unix Makefiles" -S. -Bbuild
 175 cmake --build build -- -j$(nproc)
 176 ```
 177
 178
 179 ### Subsequent builds
 180
 181 The initial build will download the gamepacks and build NetRadiant and tools. If you frequently recompile you can skip downloading the gamepacks:
 182
 183 ```sh
 184 cmake --build build --target binaries -- -j$(nproc)
 185 ```
 186
 187 You should still periodically update gamepacks:
 188
 189 ```sh
 190 cmake --build build --target gamepacks
 191 ```
 192
 193
 194 ### Build and installation details
 195
 196 #### Compilation details
 197
 198 Options:
 199
 200 * `BUILD_RADIANT=OFF`
 201   Do not build NetRadiant (default: `ON`, build netradiant graphical editor);
 202 * `BUILD_TOOLS=OFF`
 203   Do not build q3map2 and other tools (default: `ON`, build command line tools);
 204 * `BUILD_DAEMONMAP=OFF`
 205   Do not build daemonmap tool (default: `ON` if submodule is there, buils daemonmap navigation mesh generator);
 206 * `BUILD_CRUNCH=OFF`
 207   Disable crunch support (default: `ON` if submodule is there, enable crunch support);
 208 * `RADIANT_ABOUTMSG="Custom build by $(whoami)"`
 209   A message shown in the about dialog (default: `Custom build`).
 210
 211 Targets:
 212
 213 * `binaries`            Compile all binaries;
 214   - `netradiant`        Compile the netradiant editor;
 215   - `modules`           Compile all modules (each module has its own target as well);
 216   - `plugins`           Compile all plugins (each plugin has its own target as well);
 217   - `tools`             Compile all tools (each tool has its own target as well);
 218      * `quake2`         Compile all the Quake 2 tools: `q2map`, `qdata3`;
 219      * `heretic2`       Compile all the Heretic2 tools: `q2map`, `h2data`;
 220      * `quake3`         Compile all the Quake 3 tools:
 221          - `q3map2`     Compile the Quake 3 map compiler;
 222          - `q3data`     Compile the q3data tool;
 223      * `unvanquished`   Compile all the Unvanquished tools: `daemonmap`, `q3map3`, `q4data`;
 224          - `daemonmap`  Compile the daemonmap navigation mesh generator.
 225
 226 Type `make help` to get an exhaustive list of targets.
 227
 228
 229 #### Download details
 230
 231 Options:
 232
 233 * `DOWNLOAD_GAMEPACKS=OFF`
 234   Do not automatically download the gamepack data on each compilation and do not install already downloaded game packs (default: `ON`);
 235 * `GAMEPACKS_LICENSE_LIST=all`
 236   Download all gamepacks whatever their license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
 237 * `GAMEPACKS_NAME_LIST="Xonotic Unvanquished"`
 238   Download gamepacks for the given games (default: `none`, do not select more gamepacks to download).
 239
 240 Target:
 241
 242 * `gamepacks` Downloads the game pack data.
 243
 244 Run `./gamepacks-manager -h` to know about available licenses and other available games. Both lists are merged, for example setting `GAMEPACKS_LICENSE_LIST=GPL` and `GAMEPACKS_NAME_LIST=Q3` will install both GPL gamepacks and the proprietary Quake 3 gamepack.
 245
 246
 247 #### Installation details
 248
 249 Options:
 250
 251 * `BUNDLE_LIBRARIES=ON`
 252   Bundle libraries, only Linux, FreeBSD, macOS and MSYS2 are supported at this time (default: `OFF`);
 253 * `FHS_INSTALL=ON` (available on POSIX systems)
 254   Install files following the Filesystem Hierarchy Standard (`bin`, `lib`, `share`, etc.)
 255   Also setup XDG mime and application support on Linux-like systems (default: `OFF`, install like in 1999);
 256 * `CMAKE_INSTALL_PREFIX=/usr`
 257   Install system-wide on Posix systems, always set `FHS_INSTALL` to `ON` when doing this (default: `install/` directory within source tree).
 258
 259 Target:
 260
 261 * `install` Install files.
 262
 263
 264 ## Additonnal information
 265
 266 ### About Crunch
 267
 268 The crnlib used to decode `.crn` files is the one from [Dæmon](http://github.com/DaemonEngine/Daemon) which is the one by [Unity](https://github.com/Unity-Technologies/crunch/tree/unity) made cross-platform and slightly improved. Since Unity brokes compatibility with [BinomialLLC's legacy tree](https://github.com/BinomialLLC/crunch) it's required to use either the `crunch` tool from Dæmon or the one from Unity to compress textures that have to be read by radiant or q3map2.