NetRadiant
==========
-
+[](https://netradiant.gitlab.io)
-The open source, cross platform level editor for id Tech-derivated games (has lineage from GtkRadiant).
+The open source, cross platform level editor for id Tech-derivated games, heir of GtkRadiant.
-## Compatibility
+Learn more on NetRadiant website: [netradiant.gitlab.io](https://netradiant.gitlab.io).
-|System |Build |Bundle |Run |Build requirements |
-|---------|---------|---------|---------|---------------------------|
-|Linux |**Yes** |**Yes** |**Yes** |_GCC or LLVM/clang_ |
-|FreeBSD |**Yes** |_not yet_|**Yes** |_GCC_ |
-|Windows |**Yes** |**Yes** |**Yes** |_MSYS2/Mingw64 or Mingw32_ |
-|Wine |- |- |**Yes** |- |
-|macOS |**Yes** |_not yet_|_mostly_ |_GCC and patched GtkGLext_ |
-NetRadiant is known to build and run properly on Linux, FreeBSD and Windows using MSYS2. NetRadiant is known to build on macOS, 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 that system. At this time library bundling is only supported on Windows/MSYS2 and Linux. Linux bundles do not ship GTK (users are espected to have a working GTK with GtkGlExt environment).
+## Download NetRadiant
+
+Prebuilt binaries can be found on the [Download page](https://netradiant.gitlab.io/page/download/).
+
+
+## Compatibility matrix
+
+|System |Build |Bundle |Run |Build requirements |
+|---------|---------|----------|---------|----------------------------------------------|
+|Linux |**Yes** |**Yes** |**Yes** |_GCC or Clang_ |
+|FreeBSD |**Yes** |**Yes** |**Yes** |_GCC or Clang_ |
+|Windows |**Yes** |**Yes** |**Yes** |_MSYS2/Mingw64 or Mingw32_ |
+|Wine |- |- |**Yes** |- |
+|macOS |**Yes** |**Yes** |**Yes** |_Homebrew, GCC or Clang and builtin GtkGLExt_ |
+
+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.
+
+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.
## Getting the sources
-Source browser, issues and more can be found on the gitlab project: https://gitlab.com/xonotic/netradiant/
+Source browser, issues and more can be found on the gitlab project: [gitlab.com/xonotic/netradiant](https://gitlab.com/xonotic/netradiant)
The latest source is available from the git repository: `https://gitlab.com/xonotic/netradiant.git`
-The `git` client can be obtained from the Git website: http://git-scm.org
+The `git` client can be obtained from your distribution repository or from the Git website: [git-scm.org](http://git-scm.org)
-A copy of the source tree can be fetched using the command line `git` client this way:
+A copy of the source tree can be obtained by using the `git` command line client this way:
```sh
git clone --recursive https://gitlab.com/xonotic/netradiant.git
* OpenGL, LibXml2, GTK2, GtkGLExt, LibJpeg, LibPng, LibWebp, Minizip, ZLib.
-To fetch default game packages you'll need Git, Subversion and `unzip`.
+To fetch default game packages you'll need Git, Subversion, Wget and `unzip`.
+
+It's possible to build against GTK3 using the `-DGTK_TARGET=3` cmake option, but some problems may be encountered, see [GUI/GTK](https://gitlab.com/xonotic/netradiant/-/issues?label_name[]=GUI%2FGTK3) issues. GTK2 remains recommended for now.
+
### Ubuntu:
```sh
-apt-get install --reinstall build-essential cmake lib{x11,gtk2.0,gtkglext1,xml2,jpeg,webp,minizip}-dev git subversion unzip wget
+apt-get install --reinstall build-essential cmake \
+ lib{x11,gtk2.0,gtkglext1,xml2,jpeg,webp,minizip}-dev \
+ git subversion unzip wget
```
If you plan to build a bundle, you also need to install `uuid-runtime patchelf`
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`
+
### MSYS2:
Under MSYS2, the mingw shell must be used.
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):
```sh
-export PATH="/mingw64/bin:${PATH}"`
+export PATH="/mingw64/bin:${PATH}"
```
Install the dependencies this way:
```sh
-pacman -S --needed base-devel mingw-w64-$(uname -m)-{ntldd-git,subversion,unzip,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git} git
+pacman -S --needed base-devel git subversion unzip \
+ mingw-w64-$(uname -m)-{ntldd-git,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git}
```
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.
+### FreeBSD:
+
+```sh
+pkg install cmake gtkglext pkgconf minizip webp coreutils gsed git subversion wget unzip
+```
+
+If you plan to build a bundle, you also need to install `patchelf`
+
+
### macOS:
+Note: some dependencies of gtk+ seems to only be pulled with gtk+3, gtkglext seems to require libffi.
+
```sh
-brew install gcc cmake gtkglext pkgconfig minizip webp coreutils gnu-sed
+brew install cmake glib gobject-introspection libffi gtk+ gtk+3 gtk-doc pkgconfig minizip webp coreutils gnu-sed wget sassc
brew link --force gettext
```
## Submodules
- * Crunch (optional, disabled by default, only supported with CMake build)
+ * Crunch (optional, not built if submodule is not present)
-If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run it within the `netradiant` repository):
+If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run this within the `netradiant` repository):
```sh
git submodule update --init --recursive
```
-## Compiling
+## Simple compilation
+
+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.
+
+
+### Easy builder assistant
+
+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:
+
+```sh
+./easy-builder
+```
+
+If everything went right, you'll find your netradiant build in `install/` subdirectory.
+
+If you need to build a debug build (to get help from a developer, for example), you can do it this way:
+
+```sh
+./easy-builder --debug
+```
+
+By default, build tools and compilers are using the `build/` directory as workspace.
+
+For supported system, bundling dependencies can be done this way:
+
+```sh
+./easy-builder -DBUNDLE_LIBRARIES=ON
+```
+
+Note: Always do bundling on a clean and fresh system without unrelated software installed.
+
+
+## Advanced compilation
### Initial build
#### Debug build
```sh
-cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug
+cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug
cmake --build build -- -j$(nproc)
+cmake --install build
```
#### Release build
```sh
-cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release
+cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
cmake --build build -- -j$(nproc)
+cmake --install build
```
-On macOS you have to add this to the first cmake call:
-
-```sh
--DCMAKE_C_COMPILER=/usr/local/bin/gcc-9 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++-9
-```
-
-On FreeBSD you have to add this to the first cmake call:
+Note: macOS users need to build built-in GtkGLExt before building NetRadiant:
```sh
--DCMAKE_C_COMPILER=/usr/local/bin/gcc8 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++8
+cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
+cmake --build build -- -j$(nproc) builtins
+cmake -G "Unix Makefiles" -S. -Bbuild
+cmake --build build -- -j$(nproc)
+cmake --install build
```
```sh
cmake --build build --target binaries -- -j$(nproc)
+cmake --install build
```
You should still periodically update gamepacks:
```sh
cmake --build build --target gamepacks
+cmake --install build
```
Targets:
-* `binaries` Compiles all binaries;
- - `netradiant` Compiles the netradiant editor;
- - `modules` Compiles all modules (each module has its own target as well);
- - `plugins` Compiles all plugins (each plugin has its own target as well);
- - `tools` Compiles all tools (each tool has its own target as well);
- * `quake2` Compiles all the Quake 2 tools: `q2map`, `qdata3`;
- * `heretic2` Compiles all the Heretic2 tools: `q2map`, `h2data`;
- * `quake3` Compiles all the Quake 3 tools:
- - `q3map2` Compiles the quake3 map compiler;
- - `q3data` Compiles the q3data tool.
+* `binaries` Compile all binaries;
+ - `netradiant` Compile the netradiant editor;
+ - `modules` Compile all modules (each module has its own target as well);
+ - `plugins` Compile all plugins (each plugin has its own target as well);
+ - `tools` Compile all tools (each tool has its own target as well);
+ * `quake2` Compile all the Quake 2 tools: `q2map`, `qdata3`;
+ * `heretic2` Compile all the Heretic2 tools: `q2map`, `h2data`;
+ * `quake3` Compile all the Quake 3 tools:
+ - `q3map2` Compile the Quake 3 map compiler;
+ - `q3data` Compile the q3data tool;
Type `make help` to get an exhaustive list of targets.
+
#### Download details
Options:
* `DOWNLOAD_GAMEPACKS=OFF`
- Do not automatically download the gamepack data on each compilation and do not install game packs already downloaded (default: `ON`);
+ Do not automatically download the gamepack data on each compilation and do not install already downloaded game packs (default: `ON`);
* `GAMEPACKS_LICENSE_LIST=all`
- Download all gamepacks whatever the license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
+ Download all gamepacks whatever their license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
* `GAMEPACKS_NAME_LIST="Xonotic Unvanquished"`
Download gamepacks for the given games (default: `none`, do not select more gamepacks to download).
Options:
* `BUNDLE_LIBRARIES=ON`
- Bundle libraries, only MSYS2 is supported at this time (default: `OFF`);
+ Bundle libraries, only Linux, FreeBSD, macOS and MSYS2 are supported at this time (default: `OFF`);
* `FHS_INSTALL=ON` (available on POSIX systems)
Install files following the Filesystem Hierarchy Standard (`bin`, `lib`, `share`, etc.)
Also setup XDG mime and application support on Linux-like systems (default: `OFF`, install like in 1999);
* `install` Install files.
+```sh
+cmake --install build
+```
+
-## Additonnal notes
+## Additonnal information
### About Crunch
projects / xonotic / netradiant.git / blobdiff