docs/multiplayer.txt
author convert-repo
Mon, 07 Apr 2008 16:21:55 +0000
changeset 10076 dfd70e42c4ae
parent 5655 8f59540932fe
permissions -rw-r--r--
update tags
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     1
Multiplayer Manual for OpenTTD (0.3.5)
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     2
=======================================
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
     3
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
     4
1. Starting a Server
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     5
---------------------
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
     6
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     7
 - Click "multiplayer" on the startup screen
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     8
 - Click "start server"
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
     9
 - Type in a game name
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    10
 - Select the type of game ('LAN/Internet' or 'Internet (advertise)'. With the last one
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    11
    other people are able to see you online. Else they need your IP and port to join)
5655
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
    12
 - Click "start game", "load game" or "load scenario"
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    13
 - Start playing
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    14
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    15
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    16
2. Connecting to a Server
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    17
--------------------------
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    18
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    19
 - Click "multiplayer" on the startup screen
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    20
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    21
 - If you want to connect to any network game in your LAN click on 'LAN', then on
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    22
    'Find Server'
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    23
 - If you want to see which servers all online on the Internet, click on 'Internet'
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    24
    and 'Find Server'
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    25
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    26
 - If there were more then one server
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    27
   - select one in the list below the buttons
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    28
   - click on 'join game'
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    29
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    30
 - If you want to play and you have the ip or hostname of the game server you want connect to.
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
    31
   - click add server
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    32
   - type in the ip address or hostname
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    33
   - if you want to add a port use :<port>
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    34
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    35
 - Now you can select a company and press: "Join company", to help that company
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    36
 - Or you can press "Spectate game", to spectate the game
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    37
 - Or you can press "New company", and start your own company (if there are slots free)
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    38
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    39
 - You see a progressbar how far you are with joining the server.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    40
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    41
 - Happy playing
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    42
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    43
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    44
3. Connecting to a Server over the Console
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    45
-------------------------------------------
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    46
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    47
 - Open the console and type in the following command:
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    48
5655
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
    49
    connect <ip/host>:<port>#<player-no>
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    50
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    51
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    52
4. Playing Internet-Games
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    53
--------------------------
224
f4ec30638c90 (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde
parents:
diff changeset
    54
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    55
 - Since OpenTTD 0.3.5 the network protocol has been rewritten and is very stable, even over slow connections.
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
    56
5655
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
    57
 - Servers with a red dot behind it have a different version then you have. You will not be able to join those servers.
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
    58
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
    59
 - Servers with a yellow dot behind it have NewGRFs that you do not have. You will not be able to join those servers.
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
    60
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    61
 - It can happen that a connection is that slow, or you have that many clients connected to your server, that your clients start to loose their connection. Some things you can do about it:
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    62
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    63
   - net_frame_freq:
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    64
      change it in console with: net_frame_freq = <number>
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    65
     the number should be between the 0 and 10, not much higher. It indicates the delay between clicking and showing up. The higher, the more you notice it, but the less bandwidth you use.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    66
     A good value for Internet-games is 2 or 3.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    67
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    68
   - net_sync_freq:
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    69
      change it in console with: net_sync_freq = <number>
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    70
     the number should be between the 50 and 1000, not much lower, not much higer. It indicates the time between sync-frames. A sync-frame is a frame which checks if all clients are still in sync. When the value it too high, clients can desync in 1960, but the server detects it in 1970. Not really handy. The lower the value, the more bandwidth it uses.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    71
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    72
   NB: changing net_frame_freq has more effect on the bandwidth then net_sync_freq. You should never change net_sync_freq!
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    73
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    74
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    75
5. Tips for servers
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    76
--------------------
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    77
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    78
 - You can launch a dedicated server by adding -D as parameter
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    79
 - In UNIX like systems, you can fork your dedicated server by adding -f as parameter
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    80
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    81
 - You can automaticly clean companies that do not have a client connected to them, for, let's say,
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    82
      3 years. You can do this via: 'set autoclean_companies' and 'set autoclean_protected' and
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    83
      'set autoclean_unprotected'. Unprotected removes a password from a company when it is
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    84
      not used for more then the defined amount of months.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    85
 - You can also do this manually via the console: 'reset_company'.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    86
    Both ways, the company will go bankrupt.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    87
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    88
 - You can let your server automaticly restart a map when, let's say, year 2030 is reached.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    89
    See 'set restart_game_date' for detail.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    90
 - If you want to be on the server-list, enable Advertising. To do this, select 'Internet (advertise)'
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    91
    in the Start Server menu, or type in console: 'set server_advertise 1'.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    92
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    93
 - You can protect your server with a password via the console: 'set server_pw', or via the
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    94
    Start Server menu.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    95
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    96
 - When you have many clients connected to your server via Internet, watch your bandwidth (if
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    97
    you have any limit on it, set by your ISP). 1 client uses +/- 3 kb/s up and down. To decrease
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    98
    this amount, set 'net_frame_freq' to 1 for example. This will reduce it to 1.5 kb/s per client.
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
    99
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   100
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   101
6. Some useful things
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   102
----------------------
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   103
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   104
 - You can protect your company so nobody else can join uninvited. To do this, check your Company Screen
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   105
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
   106
 - You can give other players some money via the ClientList (under the 'head' in the mainbar).
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   107
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   108
 - You can chat with other players via ENTER or via SHIFT+T or via the ClientList
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   109
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
   110
 - Servers can now kick players, so don't make them use it!
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   111
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
   112
 - From 0.3.5, desyncs should not happen anymore
786
aa75e1682d39 (svn r1253) -Update: updated the multiplayer doc a bit.
truelight
parents: 543
diff changeset
   113
543
e3b43338096b (svn r942) -Merged branch/network back into the trunk
truelight
parents: 224
diff changeset
   114
 - From 0.3.5, patch-settings are also synced. You can now play without deleting openttd.cfg, and with, for example, extra large trains enabled.
5655
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   115
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   116
7. Troubleshooting
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   117
------------------
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   118
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   119
 - My advertised server does not show up in the 'advertised server list' (servers.openttd.org)
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   120
     Run openttd with the '-d net=2' parameter, as this will show whether it receives replies from the master server.
8f59540932fe (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium
parents: 786
diff changeset
   121
     If it does not receive replies it is most likely that you need to configure your router to forward the OpenTTD ports 3979 (both TCP and UDP) to the computer that is hosting the game.