annotate docs/multiplayer.txt @ 8386:b61dbe67cbb3 draft

(svn r11956) -Fix [FS#1675]: Disallow building locks and docks on rapids.
author peter1138 <peter1138@openttd.org>
date Wed, 23 Jan 2008 08:47:49 +0000
parents 2a651add2378
children bfb73cf8035d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
1 Multiplayer Manual for OpenTTD (0.3.5)
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
2 =======================================
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
3
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
4 1. Starting a Server
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
5 ---------------------
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
6
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
7 - Click "multiplayer" on the startup screen
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
8 - Click "start server"
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
9 - Type in a game name
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
10 - Select the type of game ('LAN/Internet' or 'Internet (advertise)'. With the last one
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
11 other people are able to see you online. Else they need your IP and port to join)
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
12 - Click "start game", "load game" or "load scenario"
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
13 - Start playing
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
14
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
15
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
16 2. Connecting to a Server
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
17 --------------------------
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
18
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
19 - Click "multiplayer" on the startup screen
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
20
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
21 - If you want to connect to any network game in your LAN click on 'LAN', then on
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
22 'Find Server'
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
23 - If you want to see which servers all online on the Internet, click on 'Internet'
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
24 and 'Find Server'
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
25
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
26 - If there were more then one server
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
27 - select one in the list below the buttons
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
28 - click on 'join game'
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
29
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
31 - click add server
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
32 - type in the ip address or hostname
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
33 - if you want to add a port use :<port>
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
34
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
35 - Now you can select a company and press: "Join company", to help that company
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
36 - Or you can press "Spectate game", to spectate the game
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
37 - Or you can press "New company", and start your own company (if there are slots free)
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
38
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
39 - You see a progressbar how far you are with joining the server.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
40
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
41 - Happy playing
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
42
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
43
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
44 3. Connecting to a Server over the Console
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
45 -------------------------------------------
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
46
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
47 - Open the console and type in the following command:
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
48
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
49 connect <ip/host>:<port>#<player-no>
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
50
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
51
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
52 4. Playing Internet-Games
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
53 --------------------------
224
8541dfdd241f (svn r225) -Doc: added multiplayer documentation file doc/multiplayer.txt
signde <signde@openttd.org>
parents:
diff changeset
54
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
55 - Since OpenTTD 0.3.5 the network protocol has been rewritten and is very stable, even over slow connections.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
56
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
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.
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
58
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
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.
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
60
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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:
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
62
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
63 - net_frame_freq:
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
64 change it in console with: net_frame_freq = <number>
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
66 A good value for Internet-games is 2 or 3.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
67
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
68 - net_sync_freq:
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
69 change it in console with: net_sync_freq = <number>
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
71
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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!
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
73
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
74
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
75 5. Tips for servers
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
76 --------------------
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
77
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
78 - You can launch a dedicated server by adding -D as parameter
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
79 - In UNIX like systems, you can fork your dedicated server by adding -f as parameter
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
80
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
81 - You can automaticly clean companies that do not have a client connected to them, for, let's say,
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
82 3 years. You can do this via: 'set autoclean_companies' and 'set autoclean_protected' and
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
83 'set autoclean_unprotected'. Unprotected removes a password from a company when it is
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
84 not used for more then the defined amount of months.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
85 - You can also do this manually via the console: 'reset_company'.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
86 Both ways, the company will go bankrupt.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
87
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
88 - You can let your server automaticly restart a map when, let's say, year 2030 is reached.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
89 See 'set restart_game_date' for detail.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
90 - If you want to be on the server-list, enable Advertising. To do this, select 'Internet (advertise)'
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
91 in the Start Server menu, or type in console: 'set server_advertise 1'.
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
92
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
93 - You can protect your server with a password via the console: 'set server_pw', or via the
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
94 Start Server menu.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
95
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
96 - When you have many clients connected to your server via Internet, watch your bandwidth (if
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
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.
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
99
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
100
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
101 6. Some useful things
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
102 ----------------------
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
103
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
104 - You can protect your company so nobody else can join uninvited. To do this, check your Company Screen
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
105
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
106 - You can give other players some money via the ClientList (under the 'head' in the mainbar).
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
107
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
108 - You can chat with other players via ENTER or via SHIFT+T or via the ClientList
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
109
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
110 - Servers can now kick players, so don't make them use it!
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
111
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
parents: 224
diff changeset
112 - From 0.3.5, desyncs should not happen anymore
786
a6e181bcfe8b (svn r1253) -Update: updated the multiplayer doc a bit.
truelight <truelight@openttd.org>
parents: 543
diff changeset
113
543
0bade3c3b8ba (svn r942) -Merged branch/network back into the trunk
truelight <truelight@openttd.org>
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.
5404
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
115
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
116 7. Troubleshooting
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
117 ------------------
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
118
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
parents: 786
diff changeset
119 - My advertised server does not show up in the 'advertised server list' (servers.openttd.org)
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
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.
2a651add2378 (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme.
rubidium <rubidium@openttd.org>
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.