X-Git-Url: https://git.xonotic.org/?a=blobdiff_plain;f=README.md;h=7c2191eade62b83fb0c91b2ac36023a63d713f68;hb=fa505051e63a8c5889440aa2577d75f6abe8bd9e;hp=44436fd6ae95f694940e761222c6366b31188a9e;hpb=dcb3108d544f1ab4ef130bca426d20dbd38d6f16;p=xonotic%2Fnetradiant.git diff --git a/README.md b/README.md index 44436fd6..7c2191ea 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,24 @@ NetRadiant ========== -The open source, cross platform level editor for idtech games (Radiant fork) +![NetRadiant logo](setup/data/tools/bitmaps/splash.png) -# Getting the Sources +The open source, cross platform level editor for idtech 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 ``` @@ -21,62 +26,141 @@ See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and # Dependencies - * OpenGL - * LibXml2 - * GTK2 - * GtkGLExt - * LibJpeg - * LibPng - * Minizip - * 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 -## msys2 +Under MSYS2, the mingw shell must be used. -### 32 bit: +If you use MSYS2 over SSH, add `mingw64` to the path this way (given you compile for 64 bit windows): ``` -pacman -S --needed base-devel mingw-w64-i686-{toolchain,cmake,make,gtk2,gtkglext} +export PATH="/mingw64/bin:${PATH}"` ``` -### 64 bit: +Install the dependencies this way: + ``` -pacman -S --needed base-devel mingw-w64-x86_64-{toolchain,cmake,make,gtk2,gtkglext} +pacman -S --needed base-devel mingw-w64-$(uname -m)-{toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git} git ``` -## OS X: +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 gtkglext -brew install Caskroom/cask/xquartz +brew install gcc cmake Caskroom/cask/xquartz 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 This project uses the usual CMake workflow: ## Debug -`cmake -G "Unix Makefiles" -H . -B build && cmake --build build -- -j$(nproc)` +``` +cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc) +``` ## Release -`cmake -G "Unix Makefiles" -H . -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)` +``` +cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc) +``` + +On Mac you have to add this to the first cmake call: -## More Compilation Details +``` +-DCMAKE_C_COMPILER=/usr/local/bin/gcc-9 -DCMAKE_CXX_COMPILER=/usr/local/bin/g++-9 -DOPENGL_INCLUDE_DIR=/opt/X11/include -DOPENGL_gl_LIBRARY=/opt/X11/lib/libGL.dylib +``` + +## Build and installation details + +### Compilation details options: - * `DOWNLOAD_GAMEPACKS=ON` - Automatically download the gamepack data during the first compilation - * `RADIANT_ABOUTMSG="Custom build"` + +* `BUILD_RADIANT=OFF` + Do not build NetRadiant (default: `ON`, build radiant 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` + +* `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) +* `quake3` Compiles all the Quake3 tools + - `q3map2` Compiles the quake3 map compiler + - `q3data` Compiles the q3data tool + +### Download details + +options: + +* `DOWNLOAD_GAMEPACKS=OFF` + Do not automatically download the gamepack data during the first compilation (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: + +* `game_packs` 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 that because of both the way NetRadiant works and the way bundled library loading works CMake has to do some globbing to detect some of the produced/copied files it has to install. So you have to run cmake again before installing: + +``` +cmake -H. -Bbuild && cmake --build build -- install +``` + +## 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.