NetRadiant
==========
-The open source, cross platform level editor for idtech games (Radiant fork)
+
-# Getting the Sources
+The open source, cross platform level editor for id Tech-derivated games (Radiant fork).
+
+# Getting the sources
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
-To get a copy of the source using the commandline git client:
+To get a copy of the source using the command line git client:
+
```
-git clone https://gitlab.com/xonotic/netradiant.git
+git clone --recursive https://gitlab.com/xonotic/netradiant.git
cd netradiant
```
# Dependencies
- * OpenGL
- * LibXml2
- * GTK2
- * GtkGLExt
- * LibJpeg
- * LibPng
- * ZLib
+* OpenGL
+* LibXml2
+* GTK2
+* GtkGLExt
+* LibJpeg
+* LibPng
+* LibWebp
+* Minizip
+* ZLib
+
+To fetch default game packages you'll need Git and to fetch some optional ones you'll need Subversion.
+
+## 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):
+
+```
+export PATH="/mingw64/bin:${PATH}"`
+```
+
+Install the dependencies this way:
+
+
+```
+pacman -S --needed base-devel mingw-w64-$(uname -m)-{ntldd-git,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git} git
+```
+
+Explicitely use `mingw-w64-x86_64-` or `mingw-w64-i686-` prefix if you need to target a non-default architecture.
+
+You may have to install `subversion` and `unzip` to fetch or extract some non-default game packages.
+
+
+## macOS:
+
+```
+brew install gcc cmake gtkglext pkgconfig minizip webp coreutils gnu-sed
+brew link --force gettext
+```
+
+# Submodules
+
+ * Crunch (optional, disabled by default, only supported with CMake build)
+
+If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run it within the `netradiant` repository):
+
+
+```
+git submodule update --init --recursive
+```
# Compiling
+## Initial build
+
This project uses the usual CMake workflow:
-`cmake -H. -Bbuild && cmake --build build -- -j$(nproc)``
+### Debug
+
+```
+cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug && cmake --build build -- -j$(nproc)
+```
-## linux
+### Release
```
-cmake -H. -Bbuild -G "Unix Makefiles"
+cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)
```
-## msys2
+On macOS you have to add this to the first cmake call:
-`pacman -S --needed base-devel`
+```
+-DCMAKE_C_COMPILER=/usr/local/bin/gcc-9 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++-9
+```
-### 32 bit:
+On FreeBSD you have to add this to the first cmake call:
```
-pacman -S --needed mingw-w64-i686-{toolchain,cmake,gtk2,gtkglext}
-cmake -H. -Bbuild -G "MSYS Makefiles" -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw32/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw32/lib/gtk-2.0/include
+-DCMAKE_C_COMPILER=/usr/local/bin/gcc8 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++8
```
-### 64 bit:
+## Subsequent builds
+
+The initial build will download the gamepacks and build NetRadiant and tools. If you frequently recompile you can skip downloading the gamepacks:
```
-pacman -S mingw-w64-x86_64-{toolchain,cmake,gtk2,gtkglext}
-cmake -H. -Bbuild -G "MSYS Makefiles" -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw64/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw64/lib/gtk-2.0/include
+cmake --build build --target binaries -- -j$(nproc)
```
-## OS X:
+You should still periodically update gamepacks:
```
-brew install gtkglext
-brew install Caskroom/cask/xquartz
-brew link --force gettext
+cmake --build build --target gamepacks
```
-More Compilation Details
-------------------------
+## Build and installation details
+
+### Compilation details
options:
- * `DOWNLOAD_GAMEPACKS=ON`
- Automatically download the gamepack data during the first compilation
- * `RADIANT_ABOUTMSG="Custom build"`
+
+* `BUNDLE_LIBRARIES=ON`
+ Bundle libraries (only MSYS2 is supported at this time)
+* `BUILD_RADIANT=OFF`
+ Do not build NetRadiant (default: `ON`, build netradiant graphical editor)
+* `BUILD_TOOLS=OFF`
+ Do not build q3map2 and other tools (default: `ON`, build command line tools)
+* `BUILD_CRUNCH=ON`
+ Enable crunch support (default: `OFF`, disable crunch support)
+* `RADIANT_ABOUTMSG="Custom build"`
A message shown in the about dialog
targets:
- * `radiant` Compiles the radiant core binary
- * `modules` Compiles all modules (each module has its own target as well)
- * `plugins` Compiles all plugins (each plugin has its own target as well)
- * `game_packs` Downloads the game pack data
- * `quake3` Compiles all the Quake3 tools
- - `q3map2` Quake3 map compiler
- - `q3data`
+
+* `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 Quake2 tools: `q2map`, `qdata3`
+ * `heretic2` Compiles all the Heretic2 tools: `q2map`, `h2data`
+ * `quake3` Compiles all the Quake3 tools:
+ - `q3map2` Compiles the quake3 map compiler
+ - `q3data` Compiles 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`)
+* `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)
+* `GAMEPACKS_NAME_LIST="Xonotic Unvanquished"`
+ Download gamepacks for the given games (default: `none`, do not select more gamepacks to download)
+
+target:
+
+* `gamepacks` Downloads the game pack data
+
+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.
+
+### Installation details
+
+options:
+
+* `FHS_INSTALL=ON`
+ Available for 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)
+* `CMAKE_INSTALL_PREFIX=/usr`
+ Install system-wide on Posix systems, always set `FHS_INSTALL` to `ON` when doing this (default: install in `install/` directory within source tree)
+
+target:
+
+* `install`
+ Install files
+
+## Note about Crunch
+
+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.
projects / xonotic / netradiant.git / blobdiff