]> git.xonotic.org Git - xonotic/netradiant.git/blob - README
Add a README
[xonotic/netradiant.git] / README
1 NetRadiant
2 ==========
3
4 The open source, cross platform level editor for idtech games (NetRadiant fork)
5
6
7 Getting the Sources
8 ===================
9
10 The latest source is available from the git repository:
11 https://gitlab.com/xonotic/netradiant.git
12
13 The git client can be obtained from the Git website:
14 http://git-scm.org
15
16 To get a copy of the source using the commandline git client:
17   git clone https://gitlab.com/xonotic/netradiant.git
18   cd netradiant
19
20 See also https://gitlab.com/xonotic/netradiant/ for a source browser,
21 issues and more.
22
23 Dependencies
24 ============
25
26  * OpenGL
27  * LibXml2
28  * GTK2
29  * GtkGLExt
30  * LibJpeg
31  * LibPng
32  * ZLib
33
34 Compiling
35 =========
36
37 This project uses the usual CMake workflow:
38
39   mkdir build && cd build && cmake .. && make
40
41 More Compilation Details
42 ------------------------
43
44 CMake options:
45  * DOWNLOAD_GAMEPACKS=ON
46    Automatically download the gamepack data during the first compilation
47  * RADIANT_ABOUTMSG="Custom build"
48    A message shown in the about dialog
49
50 Make targets:
51  * radiant    Compiles the radiant core binary
52  * plugins    Compiles all plugins (each plugin has its own target as well)
53  * modules    Compiles all modules (each module has its own target as well)
54  * game_packs Downloads the game pack data
55  * quake3     Compiles all the Quake3 tools
56   * q3map2    Quake3 map compiler
57   * q3data
58  * quake2     Compiles all the Quake2 tools (Note: needs to be compiled explicitly)
59   * q2map     Quake2 map compiler
60   * q2data
61   * h2data