← Back to branch summary

~ubuntu-branches/ubuntu/lucid/warzone2100/lucid

« back to all changes in this revision

Viewing changes to doc/Readme.en

  • Committer: Bazaar Package Importer
  • Author(s): Christoph Egger, Paul Wise, Christoph Egger
  • Date: 2009-06-29 17:12:52 UTC
  • mfrom: (1.1.11 upstream) (2.1.7 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090629171252-5ddnlfg3zfchrega
Tags: 2.2.1+dfsg1-1
http://bugs.debian.org/534962
https://launchpad.net/bugs/372872
[ Paul Wise ]
* New upstream release (Closes: #534962)
* Adjust the flex build-depends to take account of the conflict
  with all the versions of flex 2.5.34 (LP: #372872)
* Make the -music Recommends more strict, 2.1 music doesn't work
  with 2.2.
* Upstream moved the downloads to sourceforge, update the watch file
* Bump Standards-Version, no changes needed
* Drop use of dh_desktop since it no longer does anything
* Recommend the new warzone2100-video package, version 2.2 or similar
* Mention the warzone2100 crash reports in the -dbg package description

[ Christoph Egger ]
* Replace CC-2.0 graphic from cybersphinx, create a new tarball
* Add myself to uploaders

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Readme.en
1
1
Warzone 2100 - Readme
2
2
=====================
 
3
This file has not been updated since the release of 2.1. Some information may
 
4
not be correct any more. For current information visit the homepage of the
 
5
Warzone 2100 Resurrection Project (http://wz2100.net/).
 
6
 
3
7
Content
4
8
-------
5
9
1. Contents of Warzone 2100
6
10
2. State of the game
7
11
 2.1 Reporting bugs
8
12
3. Configuration
9
 
 3.1 WZ-dir and configuration file
10
 
 3.2 Command-line options
11
 
 3.3 Music
12
 
 3.4 Multiplaying via internet
 
13
 3.1 Warzone directory
 
14
 3.2 Configuration file
 
15
 3.3 Command-line options
 
16
 3.4 Music
 
17
 3.5 Multiplaying via internet
13
18
4. Cheats
14
19
 4.1 Cheat-mode
15
20
 4.2 Cheats lists
65
70
 
66
71
3. Configuration
67
72
================
68
 
3.1 WZ-dir and configuration file
69
 
---------------------------------
70
 
Warzone saves your configuration data in a file named "config". The location of
71
 
this file depends on the operating system.
 
73
3.1 Warzone directory
 
74
---------------------
 
75
Warzone 2100 uses an own sub-directory in a user's home direcoty to save
 
76
configuration data, save-games and certain other things. Additionally you can
 
77
use this directory to place custom maps and mods so the game can find them. The
 
78
location of this directory depends on the operating system.
72
79
 
73
 
Warzone-dir under GNU/Linux
74
 
***************************
 
80
Warzone directory under GNU/Linux
 
81
*********************************
75
82
Under GNU/Linux the warzone-dir can be found in your home-directory, it's called
76
 
".warzone2100". The leading dot indicates that it is a hidden folder so
 
83
".warzone2100-2.1". The leading dot indicates that it is a hidden directory so
77
84
depending on your configuration you may not be able to see it. However, you can
78
85
still access it by typing the path into your address-bar.
79
86
 
80
 
Warzone-dir under Windows
81
 
*************************
82
 
The folder is called "Warzone 2100" and is located in "My Documents".
 
87
Warzone directory under Windows
 
88
*******************************
 
89
The directory is called "Warzone 2100 2.1" and is located in "My Documents".
83
90
 
84
 
Warzone-dir under Mac OS X
85
 
**************************
86
 
The folder "Warzone 2100" can be found in your home-directory at:
 
91
Warzone directory under Mac OS X
 
92
********************************
 
93
The directory "Warzone 2100 2.1" can be found in your home-directory at:
87
94
~/Library/Application Support/
88
95
 
89
 
3.2 Command-line options
 
96
3.2 Configuration file
 
97
----------------------
 
98
The configuration file is just called 'config' and contains several configura-
 
99
tion options, some of them can be changed by using command-line options or using
 
100
the in-game menus, others can only be changed by editing the file by hand.
 
101
 
 
102
If at any point you did something wrong, you may delete the old configuration
 
103
file and just restart Warzone 2100. Then the game will regenerate a new configu-
 
104
ration file with default values. It may be wise to not delete and instead backup
 
105
your old configuration file in case you want to keep other options.
 
106
 
 
107
The shown values are the default values.
 
108
 
 
109
alliance=0
 
110
       Toggles permission to play with allies in Skirmish and multi player mode
 
111
       on (1) and off (0).
 
112
 
 
113
allowSubtitles=0
 
114
       Toggles subtitles during video sequences on (1) and off (0).
 
115
 
 
116
base=1
 
117
       Sets the level of start bases: No bases (0), bases (1) and advanced bases
 
118
       (2).
 
119
 
 
120
bpp=32
 
121
       Sets the colour depth in bpp = bits per pixel.
 
122
 
 
123
cdvol=50
 
124
       Sets the volume for music ranging from 0 (no sound) to 100 (loudest.
 
125
 
 
126
colour=0
 
127
       Sets your colour in the single player mode: Green (0), red (4), blue (5),
 
128
       pink (6) and cyan (7).
 
129
 
 
130
debugmode=0
 
131
       Toggles debug mode on (1) and off (0). --cheat sets this to 1. In order
 
132
       to unset to 0 the file has be to edited by hand.
 
133
 
 
134
difficulty=1
 
135
       Sets the difficulty for campaign game: easy (0), medium (1) or hard (2).
 
136
       This value is not changed by difficulty-cheats.
 
137
 
 
138
fog=1
 
139
       Sets fog to fog of war (1) or distance fog (0).
 
140
 
 
141
framerate=60
 
142
       Sets the frame rate limit.
 
143
 
 
144
fullscreen=1
 
145
       Specifies whether to start in fullscreen mode (1) or not (0).
 
146
 
 
147
fxvol=100
 
148
       Sets the volume for sound effects (user interface sounds and advisor)
 
149
       ranging from 0 (no sound) to 100 (loudest).
 
150
 
 
151
gameName=My Game
 
152
       Sets the game name for skirmish and multi player games; limited to 79
 
153
       bytes, so beware when using multi-byte characters such as German umlaute
 
154
       or Japanese kanji.
 
155
 
 
156
gameserver_port=9999
 
157
       Sets the port Warzone 2100 will listen to when hosting games, so make
 
158
       sure that you can communicate on that port.
 
159
 
 
160
gamma=20
 
161
       Sets the gamma value Warzone 2100 will use. This will have an effect on
 
162
       the whole screen, so do not be surprised to see your whole screen getting
 
163
       brighter/darker when playing in windowed mode. Minimum value is 10 and
 
164
       stands for 0.5 times the normal screen intensity, maximum value is 200
 
165
       and stands for 10 times the normal screen intensity.
 
166
 
 
167
height=480
 
168
       Sets the height of the resolution Warzone 2100 will use; equivalent to
 
169
       the height value of --resolution.
 
170
 
 
171
mapName=Rush
 
172
       Sets the default map name of the map Warzone 2100 will use when starting
 
173
       skirmish or multi player games.
 
174
 
 
175
masterserver_name=lobby.wz2100.net
 
176
       Sets the lobby server Warzone 2100 will use when entering the lobby and
 
177
       for showing your open multi player games.
 
178
 
 
179
masterserver_port=9997
 
180
       Sets the port used to communicate with the lobby server specified in
 
181
       'masterserver_name'.
 
182
 
 
183
mouseflip=1
 
184
       Toggles behaviour of camera movement when holding down the right mouse
 
185
       button and moving the mouse up and down. Tilt to the opposite direction
 
186
       of mouse movement (0) or tilt in the same direction of the mouse movement
 
187
       (1).
 
188
 
 
189
phrase0= to phrase4=
 
190
       Sets five predefinable messages used for multi player mode to throw at
 
191
       your opponent. Enter chat mode and then press F1 (phrase0) to F5
 
192
       (phrase4) to send the corresponding phrase. It is not recommended to use
 
193
       these as it may not always work as expected. These are limited to 79
 
194
       bytes, so beware if you are using multi-byte characters such as German
 
195
       umlaute or Japanese kanji.
 
196
 
 
197
playaudiocds=1
 
198
       Toggles playing of audio CDs on (1) and off (0).
 
199
 
 
200
playername=
 
201
       Sets your name used in skirmish and multi player games. There is a
 
202
       profile for every playername you ever played with in your warzone
 
203
       directory.
 
204
 
 
205
power=400
 
206
       Sets the default power level to use. You may choose any value between
 
207
       -2147483648 and 2147483647 (both times inclusively) but Warzone 2100 will
 
208
       recognise exactly three values only and fallback to medium power levels
 
209
       (400), if you specify an unknown value. You can choose from low power
 
210
       levels (100), medium power levels (400) and high power levels (700).
 
211
 
 
212
radarObjectMode=0
 
213
       Toggles friend-foe-colours on (1) and off (0). The value is not affected
 
214
       by using Ctrl+Tab.
 
215
 
 
216
radarTerrainMode=0
 
217
       Sets the radar mode Warzone 2100 will use: Terrain only (0 or 1),
 
218
       heightmap only (2), terrain and heightmap combined (3) or no terrain and
 
219
       no heightmap (4). Any value greater than or equal to 5 will make the game
 
220
       use terrain only mode.
 
221
 
 
222
reopenBuild=1
 
223
       Toggles the reopening of the build menu on (1) and off (0).
 
224
 
 
225
scroll=1000
 
226
       Defines the maximum scroll speed and scroll speed acceleration. Sane
 
227
       values range from 200 (slow) to 4000 (fast). A value of 0 would stop
 
228
       scrolling at all, which is why a hardcoded default value of 100 is used
 
229
       then. The built-in range of values in the options menu ranges from 100 to
 
230
       1600.
 
231
 
 
232
sequences=0
 
233
       Toggles the replay of video sequences on (1) and off (0). The default
 
234
       value is likely to be changed in future releases as the videos have been
 
235
       liberated.
 
236
 
 
237
shadows=1
 
238
       Toggles the rendering of shadows on (1) and off (0). Older graphics cards
 
239
       may be unable to render the game at an acceptable speed while using
 
240
       shadows. This value can be changed by --shadows (1) and --noshadows (0).
 
241
 
 
242
shake=0
 
243
       Toggles shaking of the camera when buildings are destroyed on (1) and off
 
244
       (0). This option is not affected by the shakey-cheat.
 
245
 
 
246
showFPS=0
 
247
       Toggles the display of the frames per seconds on (1) and off (0).
 
248
 
 
249
sound=1
 
250
       Toggles sound on (1) and off (0).
 
251
 
 
252
subtitles=1
 
253
       Toggles the display of subtitles during videos on (1) and off (0). Note
 
254
       that subtitles are shown even if the video does not exist.
 
255
 
 
256
textureSize=128
 
257
       Sets the texture size of terrain tiles in pixels. Valid values are 16,
 
258
       32, 64 and 128. Using lower values can increase the game's performance.
 
259
 
 
260
trapCursor=0
 
261
       Toggles the trapping of the cursor in the game window. Only useful when
 
262
       playing in windowed mode. It prevents getting off the window and clicking
 
263
       something behind it like another application or the desktop, so the game
 
264
       itself loses the focus or becomes hidden behind another window.
 
265
 
 
266
type=12
 
267
       Used for selecting a game-type, do not edit this.
 
268
 
 
269
visfog=1
 
270
       Toggles the effect used for unexplored terrain: Black tiles (1) or dimmed
 
271
       tiles (0).
 
272
 
 
273
voicevol=100
 
274
       Sets the volume for voices (weapon sounds etc.) ranging from 0 (no sound)
 
275
       to 100 (loudest).
 
276
 
 
277
width=640
 
278
       Sets the width of the resolution Warzone 2100 will use; equivalent to the
 
279
       WIDTH value of --resolution.
 
280
 
 
281
 
 
282
3.3 Command-line options
90
283
------------------------
91
284
Additionally to the configuration-file Warzone 2100 can be started with dif-
92
285
ferent options and arguments.
97
290
them in the form they are used on the operating system.
98
291
 
99
292
--fullscreen
100
 
       Starts the game in fullscreen-mode
 
293
       Starts the game in fullscreen-mode.
101
294
 
102
295
--window
103
 
       Starts the game in windowed mode
 
296
       Starts the game in windowed mode.
104
297
 
105
298
--resolution WIDTHxHEIGHT
106
299
       Sets the resolution Warzone 2100 will use; usable for fullscreen mode and
107
 
       windowed mode
 
300
       windowed mode.
108
301
 
109
302
--shadows
110
 
       Enables shadows
 
303
       Enables shadows.
111
304
 
112
305
--noshadows
113
 
       Disables shadows
 
306
       Disables shadows.
114
307
 
115
308
--sound
116
 
       Enables sound
 
309
       Enables sound.
117
310
 
118
311
--nosound
119
 
       Disables sound
 
312
       Disables sound.
120
313
 
121
314
--datadir path
122
 
       Sets the data-directory to the path specified
 
315
       Sets the data-directory to the path specified.
123
316
 
124
317
--configdir path
125
 
       Sets the configuration-directory to the path specified
 
318
       Sets the configuration-directory to the path specified.
126
319
 
127
320
--savegame name
128
 
       Loads a saved game
 
321
       Loads a saved game.
129
322
 
130
323
--cheat
131
 
       Enables the usage of cheats and debug-keys, see cheats and debug-keys
 
324
       Enables the usage of cheats and debug-keys, see cheats and debug-keys.
132
325
 
133
326
--help
134
 
       Outputs a help message and exits; only useful when run from command-line
 
327
       Outputs a help message and exits; only useful when run from command-line.
135
328
 
136
329
--debug option
137
330
       Shows debug information; option can be any of the following: all, main,
143
336
       Directs debug output to the specified file.
144
337
 
145
338
--version
146
 
       Outputs the Warzone 2100 version and exits
 
339
       Outputs the Warzone 2100 version and exits.
147
340
 
148
341
--mod_ca mod-file
149
342
       Enables the specified campaign mod. You have to specify the full name of
167
360
ther information on command-line options can be found at the Wiki of the War-
168
361
zone 2100 Resurrection Project (http://wiki.wz2100.net/command_line_options).
169
362
 
170
 
3.3 Music
 
363
3.4 Music
171
364
---------
172
 
As the original game music is part of the data that was not liberated, music is
173
 
reintroduced in a different way. A playlist-system is used that can point to any
174
 
*.ogg in your warzone-data-path. This is still experimental and we are gradually
175
 
making this more usable.
 
365
A playlist-system is used that can point to any *.ogg in your warzone music
 
366
path.
176
367
 
177
 
Warzone reads the following two playlists (in the order they are mentioned) and
178
 
the first playlist found will be used:
 
368
Warzone 2100 reads the playlist from the first location it is found, searching
 
369
in this order:
179
370
 
180
371
* Warzone-directory in your personal directory:
181
372
        o for GNU/Linux: ~/.warzone2100/music/music.wpl
182
373
        o for Windows: ~/My Documents/Warzone 2100/music/music.wpl
183
 
   o for Mac OS X: ~/Library/Application Support/Warzone 2100/music/music.wpl
 
374
        o for Mac OS X: ~/Library/Application Support/Warzone 2100/music/music.wpl
184
375
* Warzone-install-path:
185
376
        o <whereverwarzoneisinstalled>/music/music.wpl
186
377
 
187
 
Using the playlist
188
 
******************
189
 
The playlist contains two sections, [game] and [menu]. For each section you can
190
 
define a list of songs you want to be played in-game. The only supported file-
191
 
format is Ogg/Vorbis as long as all necessary libraries are installed.
192
 
 
193
 
"shuffle=yes" specifies that you want the songs to played in random order. You
194
 
need to set this for each section individually.
195
 
 
196
 
"path=." specifies that the following files are found in the folder the playlist
197
 
was found. If you do not specify a path all file-names have to be given with
198
 
"absolute" path. This "absolute" path is still relative to your warzone-data-
199
 
dir. File-names have to match those in the file-system and you can not specify
200
 
files outside of the warzone-data-dir.
 
378
The playlist is just a list of songs you want to be played in-game, one song per
 
379
line. The only supported file format is Ogg Vorbis.
201
380
 
202
381
Note: Since we are using PhysFS we recommend you to use only Latin letters in
203
382
directory and file-names (more exactly this means: A to Z, a to z, 0 to 9, _-+
204
383
and space). You will receive the following error (running with --debug sound) if
205
384
"bad" characters are used: Failed opening [[PATH TO FILE]]: Insecure filename.
206
385
 
207
 
This example shows how a playlist-file could look like:
208
 
--------------------------------------------------------------------------------
209
 
[game]
210
 
path=.
211
 
shuffle=yes
212
 
neos_aurore.ogg
213
 
neos_chocolat.ogg
214
 
neos_down.ogg
215
 
neos_esperance.ogg
216
 
neos_indy.ogg
217
 
 
218
 
[menu]
219
 
path=.
220
 
neos_symphonie_du_vide.ogg
221
 
--------------------------------------------------------------------------------
222
 
 
223
 
Music replay may be choppy, so you may want to use an external player for your
224
 
music instead.
225
 
 
226
 
3.4 Multiplaying via internet
 
386
3.5 Multiplaying via internet
227
387
-----------------------------
228
388
There are two methods to start a multiplayer-game via internet: using the host's
229
389
IP or using the lobby-server. Make sure to be able to communicate on TCP-ports
396
556
http://warzone2100.de/
397
557
 
398
558
AUTHOR: Kreuvf (kreuvf@warzone2100.de)
399
 
LAST UPDATE: 2008/06/06
 
559
LAST UPDATE: 2009/05/29