uncrustify iqmmodel code
[xonotic/netradiant.git] / README.md
1 NetRadiant
2 ==========
3
4 The open source, cross platform level editor for idtech games (Radiant fork)
5
6 # Getting the Sources
7
8 The latest source is available from the git repository:
9 https://gitlab.com/xonotic/netradiant.git
10
11 The git client can be obtained from the Git website:
12 http://git-scm.org
13
14 To get a copy of the source using the commandline git client:
15 ```
16 git clone https://gitlab.com/xonotic/netradiant.git
17 cd netradiant
18 ```
19
20 See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and more.
21
22 # Dependencies
23
24  * OpenGL
25  * LibXml2
26  * GTK2
27  * GtkGLExt
28  * LibJpeg
29  * LibPng
30  * Minizip
31  * ZLib
32
33 ## msys2
34
35 Under MSYS2, the mingw shell must be used
36
37 ### 32 bit:
38
39 ```
40 pacman -S --needed base-devel mingw-w64-i686-{toolchain,cmake,make,gtk2,gtkglext}
41 ```
42
43 ### 64 bit:
44
45 ```
46 pacman -S --needed base-devel mingw-w64-x86_64-{toolchain,cmake,make,gtk2,gtkglext}
47 ```
48
49 ## OS X:
50
51 ```
52 brew install gtkglext
53 brew install Caskroom/cask/xquartz
54 brew link --force gettext
55 ```
56
57 # Compiling
58
59 This project uses the usual CMake workflow:
60
61 ## Debug
62
63 ```
64 cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc)
65 ```
66
67 ## Release
68
69 ```
70 cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)
71 ```
72
73 ## More Compilation Details
74
75 options:
76  * `DOWNLOAD_GAMEPACKS=ON`
77    Automatically download the gamepack data during the first compilation
78  * `RADIANT_ABOUTMSG="Custom build"`
79    A message shown in the about dialog
80
81 targets:
82  * `radiant`    Compiles the radiant core binary
83  * `modules`    Compiles all modules (each module has its own target as well)
84  * `plugins`    Compiles all plugins (each plugin has its own target as well)
85  * `game_packs` Downloads the game pack data
86  * `quake3`     Compiles all the Quake3 tools
87    - `q3map2`     Quake3 map compiler
88    - `q3data`