4 ![NetRadiant logo](setup/data/tools/bitmaps/splash.png)
6 The open source, cross platform level editor for id Tech-derivated games (has lineage to GtkRadiant).
9 ## Compatibility matrix
11 |System |Build |Bundle |Run |Build requirements |
12 |---------|---------|----------|---------|-------------------------------------|
13 |Linux |**Yes** |**Yes** |**Yes** |_GCC or Clang_ |
14 |FreeBSD |**Yes** |_not yet_ |**Yes** |_GCC_ |
15 |Windows |**Yes** |**Yes** |**Yes** |_MSYS2/Mingw64 or Mingw32_ |
16 |Wine |- |- |**Yes** |- |
17 |macOS |**Yes** |_not yet_ |_mostly_ |_Homebrew, GCC and patched GtkGLExt_ |
19 NetRadiant is known to build and run properly on Linux, FreeBSD and Windows using MSYS2. NetRadiant is known to build on macOS using Homebrew, but can't display things properly without a modified GtkGLExt which is yet to be upstreamed, and issues are known. Windows build is known to work well on wine, which can be used as a fallback on macOS.
21 At this time library bundling is only supported on Windows/MSYS2 and Linux. Since bundling copies things from the host, a clean build environment has to be used in order to get a clean bundle. Linux bundle does not ship GTK (users are expected to have a working GTK environment with GtkGlExt installed).
24 ## Getting the sources
26 Source browser, issues and more can be found on the gitlab project: https://gitlab.com/xonotic/netradiant/
28 The latest source is available from the git repository: `https://gitlab.com/xonotic/netradiant.git`
30 The `git` client can be obtained from your distribution repository or from the Git website: http://git-scm.org
32 A copy of the source tree can be obtained using the command line `git` client this way:
35 git clone --recursive https://gitlab.com/xonotic/netradiant.git
42 * OpenGL, LibXml2, GTK2, GtkGLExt, LibJpeg, LibPng, LibWebp, Minizip, ZLib.
44 To fetch default game packages you'll need Git, Subversion and `unzip`.
50 apt-get install --reinstall build-essential cmake \
51 lib{x11,gtk2.0,gtkglext1,xml2,jpeg,webp,minizip}-dev \
52 git subversion unzip wget
55 If you plan to build a bundle, you also need to install `uuid-runtime patchelf`
57 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`
62 Under MSYS2, the mingw shell must be used.
64 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):
67 export PATH="/mingw64/bin:${PATH}"`
70 Install the dependencies this way:
73 pacman -S --needed base-devel git \
74 mingw-w64-$(uname -m)-{ntldd-git,subversion,unzip,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git}
77 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.
83 brew install gcc cmake gtkglext pkgconfig minizip webp coreutils gnu-sed
84 brew link --force gettext
90 * Crunch (optional, not built if submodule is not present)
92 If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run this within the `netradiant` repository):
95 git submodule update --init --recursive
101 ### Easy builder assistant
103 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:
109 If anything goes right, you'll find your netradiant build in `install/` subdirectory.
111 If you need to build a debug build (to get help from a developer, for example), you can do it that way:
114 ./easy-builder --debug
117 By default, build tools and compilers are using the `build/` directory as workspace.
120 ## Advanced compilation
124 This project uses the usual CMake workflow:
130 cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug
131 cmake --build build -- -j$(nproc)
138 cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release
139 cmake --build build -- -j$(nproc)
142 On macOS you have to add this to the first cmake call:
145 -DCMAKE_C_COMPILER=/usr/local/bin/gcc-9 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++-9
148 On FreeBSD you have to add this to the first cmake call:
151 -DCMAKE_C_COMPILER=/usr/local/bin/gcc8 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++8
155 ### Subsequent builds
157 The initial build will download the gamepacks and build NetRadiant and tools. If you frequently recompile you can skip downloading the gamepacks:
160 cmake --build build --target binaries -- -j$(nproc)
163 You should still periodically update gamepacks:
166 cmake --build build --target gamepacks
170 ### Build and installation details
172 #### Compilation details
176 * `BUILD_RADIANT=OFF`
177 Do not build NetRadiant (default: `ON`, build netradiant graphical editor);
179 Do not build q3map2 and other tools (default: `ON`, build command line tools);
181 Disable crunch support (default: `ON` if submodule is there, enable crunch support);
182 * `RADIANT_ABOUTMSG="Custom build by $(whoami)"`
183 A message shown in the about dialog (default: `Custom build`).
187 * `binaries` Compiles all binaries;
188 - `netradiant` Compiles the netradiant editor;
189 - `modules` Compiles all modules (each module has its own target as well);
190 - `plugins` Compiles all plugins (each plugin has its own target as well);
191 - `tools` Compiles all tools (each tool has its own target as well);
192 * `quake2` Compiles all the Quake 2 tools: `q2map`, `qdata3`;
193 * `heretic2` Compiles all the Heretic2 tools: `q2map`, `h2data`;
194 * `quake3` Compiles all the Quake 3 tools:
195 - `q3map2` Compiles the quake3 map compiler;
196 - `q3data` Compiles the q3data tool.
198 Type `make help` to get an exhaustive list of targets.
201 #### Download details
205 * `DOWNLOAD_GAMEPACKS=OFF`
206 Do not automatically download the gamepack data on each compilation and do not install game packs already downloaded (default: `ON`);
207 * `GAMEPACKS_LICENSE_LIST=all`
208 Download all gamepacks whatever the license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
209 * `GAMEPACKS_NAME_LIST="Xonotic Unvanquished"`
210 Download gamepacks for the given games (default: `none`, do not select more gamepacks to download).
214 * `gamepacks` Downloads the game pack data.
216 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.
219 #### Installation details
223 * `BUNDLE_LIBRARIES=ON`
224 Bundle libraries, only MSYS2 is supported at this time (default: `OFF`);
225 * `FHS_INSTALL=ON` (available on POSIX systems)
226 Install files following the Filesystem Hierarchy Standard (`bin`, `lib`, `share`, etc.)
227 Also setup XDG mime and application support on Linux-like systems (default: `OFF`, install like in 1999);
228 * `CMAKE_INSTALL_PREFIX=/usr`
229 Install system-wide on Posix systems, always set `FHS_INSTALL` to `ON` when doing this (default: `install/` directory within source tree).
233 * `install` Install files.
240 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.