summaryrefslogtreecommitdiff
path: root/HOWTOBUILD
blob: a54d610dc700cbc7f6a3f91bc8433c5ec92e4347 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
	STEP 1: Make sure you have all the necessary software.

1. Tremulous + stock maps

The game has to be installed and you'll need all the maps that come
preinstalled. It's better if you didn't have any other maps while compiling
Analmango.

2. q3map2, the map compiler

A good, recent version is distributed along with NetRadiant:
https://www.icculus.org/netradiant

3. mapcat, the map concatenator

Analmango comes in parts which have to be assembled by a special program.
https://zittrig.eu/git/enneract/mapcat

4. GNU Make
5. Bash all the standard tools you'd expect on a Linux system
6. zip (if you want a .pk3)

	STEP 2: Configure the build process.

Create a file named "Makefile.local" in the same directory as "Makefile" and
put settings you want to override in it. For example:

Q3MAP_THREADS = 4
FS_BASEPATH = /opt/tremulous
.. and so on.

Settings you can override:

FS_BASEPATH   = path to your Tremulous installation
FS_HOMEPATH   = path to your Tremulous "home" folder
TREMULOUS     = path to Tremulous's executable (optional).
Q3MAP_THREADS = number of threads q3map2 should use
Q3MAP2        = path to q3map2's executable

	STEP 3: Make Analmango files visible to q3map.

The following folders have to be in FS_BASEPATH/base or FS_HOMEPATH/base: env,
levelshots, maps, models, scripts, sound, textures. You don't have to copy them,
a symlink will suffice.

	STEP 4: Run make

make          - assemble the entire map and compile it.
make test     - compile and run Tremulous
make clean    - remove all built files

You can also set a few environment variables:

PART=... make - build a single part (e.g. PART=p8_outside make test).
FAST=... make - save some time by compiling with shittier light (FAST=1) or no
                light at all (FAST=2).