4 ![NetRadiant logo](setup/data/tools/bitmaps/splash.png)
6 The open source, cross platform level editor for idtech games (Radiant fork).
10 The latest source is available from the git repository:
11 https://gitlab.com/xonotic/netradiant.git
13 The git client can be obtained from the Git website:
16 To get a copy of the source using the command line git client:
19 git clone --recursive https://gitlab.com/xonotic/netradiant.git
23 See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and more.
39 Under MSYS2, the mingw shell must be used
44 pacman -S --needed base-devel mingw-w64-i686-{toolchain,cmake,make,gtk2,gtkglexti,libwebp}
50 pacman -S --needed base-devel mingw-w64-x86_64-{toolchain,cmake,make,gtk2,gtkglext,libwebp}
58 brew install Caskroom/cask/xquartz
59 brew link --force gettext
64 * Crunch (optional, disabled by default, only supported with CMake build)
66 If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run it within the NetRadiant repository):
70 git submodule update --init --recursive
75 This project uses the usual CMake workflow:
80 cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc)
86 cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)
89 ## Build and installation details
91 ### Compilation details
96 Do not build NetRadiant (default: `ON`, build radiant graphical editor)
98 Do not build q3map2 and other tools (default: `ON`, build command line tools)
100 Enable crunch support (default: `OFF`, disable crunch support)
101 * `RADIANT_ABOUTMSG="Custom build"`
102 A message shown in the about dialog
106 * `radiant` Compiles the radiant core binary
107 * `modules` Compiles all modules (each module has its own target as well)
108 * `plugins` Compiles all plugins (each plugin has its own target as well)
109 * `quake3` Compiles all the Quake3 tools
110 - `q3map2` Compiles the quake3 map compiler
111 - `q3data` Compiles the q3data tool
117 * `DOWNLOAD_GAMEPACKS=OFF`
118 Do not automatically download the gamepack data during the first compilation (default: `ON`)
119 * `GAMEPACKS_LICENSE_LIST=all`
120 Download all gamepacks whatever the license (default: `free`, download free gamepacks)
121 * `GAMEPACKS_NAME_LIST=Xonotic Unvanquished`
122 Download gamepacks for the given games (default: `none`, do not select more gamepacks to download)
126 * `game_packs` Downloads the game pack data
128 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 proprietary Quake 3 one.
130 ### Installation details
135 Install files following the Filesystem Hierarchy Standard (bin, lib, share, etc.), also setup XDG mime and application support on POSIX systems (default: `OFF`, install like in 1999)
136 * `CMAKE_INSTALL_PREFIX=/usr`
137 Install system-wide on Posix systems, always set `FHS_INSTALL` to `ON` when doing this (default: install in `install/` directory within source tree)
146 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.