← Back to branch summary

~ubuntu-branches/debian/sid/freeciv/sid

« back to all changes in this revision

Viewing changes to doc/README

  • Committer: Package Import Robot
  • Author(s): Clint Adams, Karl Goetz, Clint Adams
  • Date: 2011-08-28 22:40:00 UTC
  • mfrom: (1.2.19 upstream)
  • Revision ID: package-import@ubuntu.com-20110828224000-j2r1erewlem25dox
Tags: 2.3.0-1
[ Karl Goetz ]
* New upstream version.
* Fix themes_sdl_use_system_fonts.diff to apply cleanly on 2.3.0
* Massage work_around_unity_induced_breakage.diff to get it
  applying to the new codebase (The patch assumes commits made
  after 2.3.0 was tagged upstream).

[ Clint Adams ]
* Fudge build system to think there is no libtool mismatch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/README
1
1
===================
2
 
Freeciv Version 2.2
 
2
Freeciv Version 2.3
3
3
===================
4
4
 
5
5
Welcome to Freeciv!
62
62
Freeciv compiled and installed on your machine.
63
63
 
64
64
 
65
 
Starting a new game:
66
 
====================
67
 
 
68
 
Freeciv is actually two programs, a server and a client.  When a game
69
 
is in progress, there will be one server program running, and as many
70
 
client programs as there are human players.  The server does not need
71
 
X, but the clients do.
 
65
Freeciv is modular:
 
66
===================
 
67
 
 
68
Freeciv is actually several programs, a server and one or more clients.  When
 
69
a game is in progress, there will be one server program running, and as many
 
70
client programs as there are human players.  The server does not use a gui,
 
71
but the clients do.  The clients come in many flavors:
 
72
 
 
73
freeciv-gtk2:  This uses the X Window System along with GTK+ 2 libraries.  To
 
74
  install, see section 1a of the INSTALL document.  This client is better
 
75
  supported and more developed than the others, as such it is considered to be
 
76
  the default interface throughout the rest of this document.
 
77
 
 
78
freeciv-sdl:  This uses Simple DirectMedia Layer libraries.  This client is
 
79
  currently unmaintained but is usable.
 
80
 
 
81
freeciv-xaw:  This uses the X Window System along with its Athena Widget
 
82
 interface.  It is somewhat minimalistic compared to the others.
 
83
 
 
84
 
 
85
Starting a game:
 
86
================
72
87
 
73
88
  NOTE:
74
89
  The following examples assume that Freeciv has been installed on
75
 
  your system, and that the directory containing the "civclient"
76
 
  and "civserver" programs is in your PATH.  If Freeciv is not
 
90
  your system, and that the directory containing the "freeciv-gtk2"
 
91
  and "freeciv-server" programs is in your PATH.  If Freeciv is not
77
92
  installed, then you may want to use the "civ" and "ser" programs,
78
93
  which can be found in the top Freeciv directory.  They are used
79
 
  in exactly the same fashion as "civclient" and "civserver".
 
94
  in exactly the same fashion as "freeciv-gtk2" and "freeciv-server".
80
95
 
81
96
Running Freeciv involves starting the server, then the client(s)
82
97
and AI(s), then telling the server to start the game.  Here are the
86
101
 
87
102
  To start the server:
88
103
 
89
 
  |  % civserver
 
104
  |  % freeciv-server
90
105
 
91
106
  Or for a list of command-line options:
92
107
 
93
 
  |  % civserver --help
 
108
  |  % freeciv-server --help
94
109
 
95
110
  Once the server is started, a prompt will appear:
96
111
 
142
157
  This will make the map twice as large as the default.
143
158
 
144
159
Client:
145
 
 
 
160
  
146
161
  Now all the human players should join, by running the Freeciv
147
162
  client:
148
163
 
149
 
  |  % civclient
 
164
  |  % freeciv-gtk2
150
165
 
151
166
  This assumes the server is running on the same machine.  If not, you
152
167
  can either specify it on the command line with the '--server' option,
155
170
  For example, suppose the server is running on a different machine
156
171
  called 'neptune'.  Then players would join with a command like:
157
172
 
158
 
  |  % civclient --server neptune
 
173
  |  % freeciv-gtk2 --server neptune
159
174
 
160
175
  If you're the only human player, then only one client needs to be
161
176
  started.  In standard Unix fashion you can start the client
162
177
  "in the background" by appending an ampersand:
163
178
 
164
 
  |  % civclient &
 
179
  |  % freeciv-gtk2 &
165
180
 
166
181
  Another option for the client you may like to try is the '--tiles'
167
182
  option, which can be used to select different "tilesets" (that is,
177
192
  To try another one, for instance the trident tileset, start the
178
193
  client with:
179
194
 
180
 
  |  % civclient --tiles trident
 
195
  |  % freeciv-gtk2 --tiles trident
181
196
 
182
197
  Other tilesets are available from http://www.freeciv.org/wiki/Tilesets
183
198
 
229
244
And the game is on!
230
245
 
231
246
  NOTE: In this version of Freeciv, the GTK and SDL clients have the
232
 
  capability to automagically start a civserver session when the user
 
247
  capability to automagically start a freeciv-server session when the user
233
248
  selects "Start New Game" from the main menu. This reduces the steps
234
249
  needed to get started playing a game of Freeciv. On the other hand,
235
250
  it also means that if the client crashes for some reason or becomes
236
 
  unavailable, the civserver session will also be lost. So starting a
237
 
  separate civserver session and then connect to it with the client is
 
251
  unavailable, the freeciv-server session will also be lost. So starting a
 
252
  separate freeciv-server session and then connect to it with the client is
238
253
  generally the recommended method.
239
254
 
240
255
 
247
262
  http://meta.freeciv.org/
248
263
 
249
264
It is a list of Freeciv servers.  To make your own server announce itself
250
 
there, start civserver with the '--meta' option, or just '-m' for short.
 
265
there, start freeciv-server with the '--meta' option, or just '-m' for short.
251
266
 
252
267
Caveats:
253
268
 
256
271
    incompatible with 1.14.2 or earlier versions.
257
272
 
258
273
 2) If the Metaserver button in the connection dialog doesn't work,
259
 
    check if your ISP uses a mandatory WWW proxy and make civclient
 
274
    check if your ISP uses a mandatory WWW proxy and make freeciv-gtk2
260
275
    use it through the $http_proxy environment variable.  For instance,
261
276
    if the proxy is proxy.myisp.com port 8888, set $http_proxy
262
277
    to http://proxy.myisp.com:8888/ before starting the client.
357
372
 
358
373
You can restore a saved game by using the '-f' server option, eg:
359
374
 
360
 
  |  % civserver -f oursave2001.sav
 
375
  |  % freeciv-server -f oursave2001.sav
361
376
 
362
377
or, if the save-file was created by a server that compressed it:
363
378
 
364
 
  |  % civserver -f oursave2001.sav.gz
 
379
  |  % freeciv-server -f oursave2001.sav.gz
365
380
 
366
381
Now the players can rejoin the game:
367
382
 
368
 
  |  % civclient -n Alexander
 
383
  |  % freeciv-gtk2 -n Alexander
369
384
 
370
385
Notice how the player-name is specified with the -n option. It's vital
371
386
that the player uses the same name as they had when the game was running,
382
397
You may choose which local language to use by specifying a "locale".
383
398
Each locale has a standard name (e.g., 'de' for German).  If you have
384
399
installed Freeciv, you may choose a locale by setting the environment
385
 
variable LANG to that locale's standard name before running civserver
386
 
and civclient.
 
400
variable LANG to that locale's standard name before running freeciv-server
 
401
and freeciv-gtk2.
387
402
 
388
403
For example, assuming you wish to use the German localization, you
389
404
would do:
438
453
 
439
454
Example:
440
455
 
441
 
  |  % civserver -l my.log -d 3
 
456
  |  % freeciv-server -l my.log -d 3
442
457
 
443
458
This sends all server log messages to file "my.log", including verbose
444
459
level messages.
445
460
 
446
461
Example:
447
462
 
448
 
  |  % civclient --debug 0
 
463
  |  % freeciv-gtk2 --debug 0
449
464
 
450
465
This suppresses all non-fatal client log messages.
451
466
 
452
467
Example:
453
468
 
454
 
  |  % civserver -d 4:log:civserver,120,500:autoattack
 
469
  |  % freeciv-server -d 4:log:civserver,120,500:autoattack
455
470
 
456
471
This turns on all fatal, error, normal and verbose messages for the
457
472
server, and debug level messages for some specified modules.  Note