home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 September / PCWELT_9_2006.ISO / pcwsoft / Freeciv-2.0.8-win32-gtk2-setup.exe / doc / README < prev    next >
Encoding:
Text File  |  2005-10-13  |  17.2 KB  |  537 lines

  1. =====================
  2. Freeciv Version 2.0.1
  3. =====================
  4.  
  5. Welcome to Freeciv!
  6.  
  7. This archive contains Freeciv, a free Civilization clone, primarily
  8. for X under Unix.  It has support for multiplayer games locally or
  9. over a network, and an AI which gives most people a run for their money.
  10.  
  11. Freeciv aims to be mostly rule-compatible with Civilization II [tm],
  12. published by Sid Meier and Microprose [tm].  A few rules are different
  13. where we think it makes more sense, and we have lots and lots of
  14. adjustable parameters to make customizing games possible.
  15.  
  16. Freeciv has been implemented completely independently of Civilization;
  17. you do not need to own Civilization to play Freeciv.
  18.  
  19. Allthough the computer players can't yet negotiate, the rules are very
  20. complete, and our multiplayer and networking code is excellent.
  21.  
  22.  
  23. Translations:
  24. =============
  25.  
  26. You may find a translated version of this file, as well as of other parts
  27. of the Freeciv documentation, in the following places:
  28.  
  29.     Dutch            ./doc/nl
  30.     French            ./doc/fr
  31.     German            ./doc/de
  32.     Italian            ./doc/it
  33.     Japanese        ./doc/ja
  34.     Swedish            ./doc/sv
  35.  
  36. Even if there is no translation for your language, the game itself may be
  37. support it. Please see "Native Language Support" below.
  38.  
  39.  
  40. Web site:
  41. =========
  42.  
  43. Freeciv's web site is here:
  44.  
  45.   http://www.freeciv.org/
  46.  
  47. We invite you to visit.  You can get the latest Freeciv news, releases
  48. and patches, find out about the Freeciv mailing lists, and see the
  49. Freeciv metaserver, which records games being played around the world.
  50.  
  51.  
  52. License:
  53. ========
  54.  
  55. Freeciv is released under the GNU General Public License.  In short,
  56. you may copy this program (including source) freely, but see the
  57. COPYING file for full details.
  58.  
  59.  
  60. Compiling and installing:
  61. =========================
  62.  
  63. Please read the INSTALL file carefully for instructions on how to get
  64. Freeciv compiled and installed on your machine.
  65.  
  66.  
  67. Starting a new game:
  68. ====================
  69.  
  70. Freeciv is actually two programs, a server and a client.  When a game
  71. is in progress, there will be one server program running, and as many
  72. client programs as there are human players.  The server does not need
  73. X, but the clients do.
  74.  
  75.   NOTE:
  76.   The following examples assume that Freeciv has been installed on
  77.   your system, and that the directory containing the "civclient"
  78.   and "civserver" programs is in your PATH.  If Freeciv is not
  79.   installed, then you may want to use the "civ" and "ser" programs,
  80.   which can be found in the top Freeciv directory.  They are used
  81.   in exactly the same fashion as "civclient" and "civserver".
  82.  
  83. Running Freeciv involves starting the server, then the client(s)
  84. and AI(s), then telling the server to start the game.  Here are the
  85. steps:
  86.  
  87. Server:
  88.  
  89.   To start the server:
  90.  
  91.   |  % civserver
  92.  
  93.   Or for a list of command-line options:
  94.  
  95.   |  % civserver --help
  96.  
  97.   Once the server is started, a prompt will appear:
  98.  
  99.   |  For introductory help, type 'help'.
  100.   |  >
  101.  
  102.   and, you can see this information by using the help command:
  103.  
  104.   |  > help
  105.   |  Welcome - this is the introductory help text for the Freeciv server.
  106.   |
  107.   |  Two important server concepts are Commands and Options.
  108.   |  Commands, such as 'help', are used to interact with the server.
  109.   |  Some commands take one or more parameters, separated by spaces.
  110.   |  In many cases commands and command arguments may be abbreviated.
  111.   |  Options are settings which control the server as it is running.
  112.   |
  113.   |  To find out how to get more information about commands and options,
  114.   |  use 'help help'.
  115.   |
  116.   |  For the impatient, the main commands to get going are:
  117.   |    show   -  to see current options
  118.   |    set    -  to set options
  119.   |    start  -  to start the game once players have connected
  120.   |    save   -  to save the current game
  121.   |    quit   -  to exit
  122.   |  >
  123.  
  124.   If you like, you can use the 'set' command to set any of the various
  125.   server options for the game.  You can get a list of the options
  126.   with the 'show' command, and detailed descriptions of each with the
  127.   'help <option-name>' command.
  128.  
  129.   For example:
  130.  
  131.   | > help size
  132.   |  Option: size  -  Map size in 1,000 tiles units
  133.   |  Description:
  134.   |    This value is used to determine the map dimensions.
  135.   |      size = 4 is a normal map of 4,000 tiles (default)
  136.   |      size = 20 is a huge map of 20,000 tiles
  137.   | Status: changeable
  138.   | Value: 4, Minimum: 1, Default: 4, Maximum: 29
  139.  
  140.   And:
  141.  
  142.   |  > set size 8
  143.  
  144.   This will make the map twice as large as the default.
  145.  
  146. Client:
  147.  
  148.   Now all the human players should join, by running the Freeciv
  149.   client:
  150.  
  151.   |  % civclient
  152.  
  153.   This assumes the server is running on the same machine.  If not, you
  154.   can either specify it on the command use with the '--server' option,
  155.   or enter it into the first dialog box once the client starts.
  156.  
  157.   For example, suppose the server is running on a different machine
  158.   called 'neptune'.  Then players would join with a command like:
  159.  
  160.   |  % civclient --server neptune
  161.  
  162.   If you're the only human player, then only one client needs to be
  163.   started.  In standard Unix fashion you can start the client
  164.   "in the background" by appending an ampersand:
  165.  
  166.   |  % civclient &
  167.  
  168.   Another option for the client you may like to try is the '--tiles'
  169.   option, which can be used to select different "tilesets" (that is,
  170.   different graphics for the map terrain, units, and so on).  The
  171.   distribution comes with 2 main tilesets:
  172.   - isotrident: An isometric tileset similar in shape to the one in civ 2. 
  173.     (not yet supported by the Xaw client.)
  174.   - trident: a civ1-style tileset with 30x30 tiles.
  175.     The trident tileset has a variant called "trident_shields".
  176.  
  177.   In this release the isotrident tileset is the default in the GTK+,
  178.   amiga, and win32 clients, while the Xaw client has trident as default. 
  179.   The "_shields" variants use a shield-shaped flag, which is smaller and 
  180.   may be less obscured. Try them both and decide for yourself -- to
  181.   use the trident tileset start the client with:
  182.  
  183.   |  % civclient --tiles trident
  184.  
  185.   Other tilesets are available from the ftp and websites.
  186.  
  187.  
  188.   Clients can be authorized to issue server commands.  To allow them
  189.   to use informational commands only, type at the server prompt
  190.  
  191.   |  > cmdlevel info
  192.  
  193.   Clients can now use '/help', '/list', '/show settlers', etc.
  194.  
  195. Computer Players:
  196.  
  197.   There are two ways to create AI players.  The first is to set
  198.   the number of players (human and AI) by setting the 'aifill'
  199.   server option.  For example:
  200.  
  201.   |  > set aifill 7
  202.  
  203.   After using the 'start' server command to start the game, any players
  204.   which aren't controlled by humans will be AI players.  For the above,
  205.   if two human players had joined, 5 AI players would be created.
  206.  
  207.   The second way is to explicitly create an AI with the 'create'
  208.   server command.  For example:
  209.  
  210.   |  > create HumanKiller
  211.  
  212.   This will create an AI-controlled player called HumanKiller.
  213.  
  214.   AI players are assigned to nations after all human players have
  215.   chosen their nations, but you can choose a particular nation for an
  216.   AI player by using the normal name for that nation's leader.  For
  217.   example, to play against AI-controlled Romans, use this server
  218.   command:
  219.  
  220.   |  > create Caesar
  221.  
  222.   Note, this is just a preference:  If no other human player chooses
  223.   to play the Romans, then this AI will.
  224.  
  225. Server:
  226.  
  227.   When everybody has joined (use the "list" command to see who's in),
  228.   start the game with the "start" command:
  229.  
  230.   |  > start
  231.  
  232. And the game is on!
  233.  
  234.  
  235. Announcing the game:
  236. ====================
  237.  
  238. If you do not want to limit your opponents to local friends or AI players,
  239. visit the Freeciv metaserver:
  240.  
  241.   http://meta.freeciv.org/metaserver.phtml
  242.  
  243. It is a list of Freeciv servers.  To make your own server announce itself
  244. there, start civserver with the '--meta' option, or just '-m' for short.
  245.  
  246. Caveats:
  247.  
  248.  1) Due to the inclusion of new features, different client and server
  249.     versions are often incompatible. The 2.0.0 version is for example
  250.     incompatible with 1.14.2 or earlier versions.
  251.  
  252.  2) If the Metaserver button in the connection dialog doesn't work,
  253.     check if your ISP uses a mandatory WWW proxy and make civclient
  254.     use it through the $http_proxy environment variable.  For instance,
  255.     if the proxy is proxy.myisp.com port 8888, set $http_proxy
  256.     to http://proxy.myisp.com:8888/ before starting the client.
  257.  
  258.  3) Sometimes there are no games on the metaserver.  That happens.
  259.     The number of players there vary with the time of the day. Try 
  260.     starting one yourself!
  261.  
  262.  
  263. Playing the game:
  264. =================
  265.  
  266. The game may be saved the game at any time using the 'save' server
  267. command, like so:
  268.  
  269.   |  > save mygame.sav
  270.  
  271. (If your server is compiled with compression support, and the
  272. 'compress' server option is set to other than 0 (zero), then the
  273. file written may be compressed and called 'mygame.sav.gz'.)
  274.  
  275. The Freeciv client works pretty much as you would expect from a
  276. multiplayer civilization game.  That is, the human players all move
  277. at the same time, then all the AI players move when all the human
  278. players have completed their turn.  There's a turn timeout value,
  279. which is by default set to 0 seconds (no timeout).  The server
  280. operator can alter this value at any time with the 'set' command.
  281.  
  282. Have a look at the online help system. All three mouse-buttons are
  283. used, and documented in the help.
  284.  
  285. Players can push the 'Return' key to announce the end of their turn,
  286. or just push the 'Turn Done' button.
  287.  
  288. Use the 'Players' dialog to see who has announced their end of turn,
  289. and who you're waiting for.  (Hey feller, are you asleep or what?? ;).
  290.  
  291. Use the input line at the bottom of the window for broadcasting
  292. messages to other players.
  293.  
  294. You can send a message to an individual player (e.g., 'peter') like so:
  295.  
  296.   |  peter: move that armor away *NOW*!
  297.  
  298. The server is smart enough to perform "name completion", so if you had
  299. typed "pet:", it will find a player name that matches the part of the
  300. name you typed.
  301.  
  302. You can send a message to all your allies by prefixing it with the 
  303. letter '.' (yes, that is a period).
  304.  
  305. You can issue server commands from the client input line:
  306.  
  307.   |  /list
  308.   |  /set settlers 4
  309.   |  /save mygame.sav
  310.  
  311. The server operator will probably let you issue informational commands
  312. only.  This is partly because allowing clients to use all server
  313. commands has security implications; consider if a player tried:
  314.  
  315.   |  /save /etc/passwd
  316.  
  317. Of course the server should not be running with superuser privileges in
  318. any case, to reduce this sort of risk.
  319.  
  320. If you're just starting, and would like to get an idea of a strategy,
  321. have a look in the Freeciv playing HOWTO, contained in the HOWTOPLAY
  322. file.
  323.  
  324. For lots more information about the client, the server, and the
  325. concepts and rules of the game, see the Freeciv manual, available
  326. at the web pages at:
  327.  
  328.   http://www.freeciv.org/index.php/Manual
  329.  
  330.  
  331. Ending the game:
  332. ================
  333.  
  334. There are three ways in which a game can end:
  335.  
  336. 1) Only one nation is left.
  337. 2) The final year is reached.
  338. 3) A player builds and launches a spaceship, which reaches Alpha
  339.    Centauri first.
  340.  
  341. A score-table will be shown in all cases.  Hint: The server operator
  342. can set the final year while the game is still going by changing the
  343. 'end-year' option.  This is nice when the winner is obvious, but you
  344. don't want to play through the boring 'cleanup phase'.
  345.  
  346.  
  347. Restoring games:
  348. ================
  349.  
  350. You can restore a saved game by using the '-f' server option, eg:
  351.  
  352.   |  % civserver -f oursave2001.sav
  353.  
  354. or, if the save-file was created by a server that compressed it:
  355.  
  356.   |  % civserver -f oursave2001.sav.gz
  357.  
  358. Now the players can rejoin the game:
  359.  
  360.   |  % civclient -n Alexander
  361.  
  362. Notice how the player-name is specified with the -n option. It's vital
  363. that the player uses the same name as they had when the game was running,
  364. if they're to be allowed in.
  365.  
  366. The game may then be restarted with the 'start' command as usual.
  367.  
  368.  
  369. Native Language Support:
  370. ========================
  371.  
  372. Freeciv supports several local languages.
  373.  
  374. You may choose which local language to use by specifying a "locale".
  375. Each locale has a standard name (e.g., 'de' for German).  If you have
  376. installed Freeciv, you may choose a locale by setting the environment
  377. variable LANG to that locale's standard name before running civserver
  378. and civclient.
  379.  
  380. For example, assuming you wish to use the German localization, you
  381. would do:
  382.  
  383.   export LANG; LANG=de   (in the Bourne shell (sh)),
  384. or
  385.   setenv LANG de         (in the C shell (csh)).
  386.  
  387. (You could do this in your .profile or .login file.)
  388.  
  389.  
  390. Log messages:
  391. =============
  392.  
  393. Both the client and server print messages known as "log messages".
  394. There are five categories of log messages: "fatal", "error", "normal",
  395. "verbose", and "debug".
  396.  
  397. By default, fatal, error and normal messages are printed to standard 
  398. output where the client or server was started.  You can direct log 
  399. messages to a file instead of the screen with the "--log filename", 
  400. or "-l filename" command line options.
  401.  
  402. You can change the level of log messages displayed with "--debug
  403. level" or "-d level" (or instead "-de level" for the Xaw client, since
  404. "-d" is ambiguous between "-debug" and "-display"), where "level" is
  405. 0, 1, 2, or 3.  0 means show fatal messages only, 1 means show fatal
  406. and error messages, 2 means fatal, error and normal messages (the
  407. default), and 3 means show all fatal, error, normal, and verbose
  408. messages.
  409.  
  410. If you compiled with DEBUG defined (an easy way to do this is to
  411. configure with --enable-debug), then you can get debug level messages
  412. by setting the level to 4.  Also, it is possible to control debug
  413. level messages (but not other messages) on a per-file and per-line
  414. basis.  To do this use "--debug 4:str1:str2" (as many strings as you
  415. like, separated by colons) and any filenames which match those strings
  416. as a substring will have debug log messages turned on, and all other
  417. debug messages will be suppressed.  To control lines, use:
  418. "--debug 4:str1,min,max" and for files which match str1 only debug
  419. messages within the specified minimum and maximum lines will be
  420. printed.  Only one set of (min,max) can be applied to each file.
  421.  
  422. Example:
  423.  
  424.   |  % civserver -l my.log -d 3
  425.  
  426. This sends all server log messages to file "my.log", including verbose
  427. level messages.
  428.  
  429. Example:
  430.  
  431.   |  % civclient --debug 0
  432.  
  433. This suppresses all non-fatal client log messages.
  434.  
  435. Example:
  436.  
  437.   |  % civserver -d 4:log:civserver,120,500:autoattack
  438.  
  439. This turns on all fatal, error, normal and verbose messages for the
  440. server, and debug level messages for some specified modules.  Note
  441. that "log" will match "gamelog.c" as well as "log.c".  For
  442. "civserver.c", debug messages between lines 120 and 500 will be
  443. printed.  This example only works if the server was compiled with
  444. DEBUG.
  445.  
  446.  
  447. Bugs:
  448. =====
  449.  
  450. Found a bug?  We really want to hear from you so we can fix it.
  451. See the file BUGS, for a list of known bugs in this release, and
  452. information about reporting new bugs.
  453.  
  454.  
  455. Mailing lists:
  456. ==============
  457.  
  458. We maintain 8 mailing lists:
  459.  
  460.   freeciv          General discussion.
  461.   freeciv-announce Announcements of general interest.
  462.                    This is a "Read Only" list, with infrequent messages.
  463.                    In other words you can't mail this list, just read it.
  464.                    (Announcements sent to this are also sent to freeciv.)
  465.   freeciv-i18n     Freeciv translation.
  466.                    All discussions related to translating the Freeciv code,
  467.                    documentation, and website, into other languages than
  468.                    English.
  469.   freeciv-dev      Freeciv development.
  470.   freeciv-data     Freeciv data directory development.
  471.                    (Discussion of rulesets, tilesets, etc.)
  472.   freeciv-java     Freeciv Java client development.
  473.   freeciv-ai       Freeciv AI development.
  474.   freeciv-cvs      Notifications of changes to the CVS repository.
  475.                    This is a "Read Only" list, carrying automated messages.
  476.                    In other words you can't mail this list, just read it.
  477.  
  478. All lists are open to the general public and everyone is welcome to join.
  479.  
  480. To join (or leave) these lists follow these steps:
  481.  
  482.   1. Email to <listar@freeciv.org>.
  483.   2. Leave subject blank.
  484.   3. In the body of the email put one of:
  485.       To join:
  486.         subscribe freeciv
  487.         subscribe freeciv-announce
  488.         subscribe freeciv-i18n
  489.         subscribe freeciv-dev
  490.         subscribe freeciv-data
  491.         subscribe freeciv-java
  492.         subscribe freeciv-ai
  493.         subscribe freeciv-cvs
  494.       To leave:
  495.         unsubscribe freeciv
  496.         unsubscribe freeciv-announce
  497.         unsubscribe freeciv-i18n
  498.         unsubscribe freeciv-dev
  499.         unsubscribe freeciv-data
  500.         unsubscribe freeciv-java
  501.         unsubscribe freeciv-ai
  502.         unsubscribe freeciv-cvs
  503.  
  504. To send an email to the lists, address it to:
  505.  
  506.   For freeciv, mail should be sent to <freeciv@freeciv.org>.
  507.   For freeciv-i18n, mail should be sent to <freeciv-i18n@freeciv.org>.
  508.   For freeciv-dev, mail should be sent to <freeciv-dev@freeciv.org>.
  509.   For freeciv-data, mail should be sent to <freeciv-data@freeciv.org>.
  510.   For freeciv-java, mail should be sent to <freeciv-java@freeciv.org>.
  511.   For freeciv-ai, mail should be sent to <freeciv-ai@freeciv.org>.
  512.  
  513.  
  514. Internet Relay Chat (IRC)
  515. =========================
  516.  
  517. Several players and developers hang out on #freeciv on the freenode
  518. network. Try connecting to the server
  519.  
  520.     irc.freenode.net
  521.  
  522.  
  523. New Releases:
  524. =============
  525.  
  526. We hope to make a major new release of Freeciv available about every
  527. four months.  Check the Freeciv website from time to time to see if
  528. there's a newer version!!
  529.  
  530.  
  531. And finally:
  532. ============
  533.  
  534. Have fun and give 'em hell!
  535.  
  536.                                    -- The Freeciv team.
  537.