summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorGuillaume Melquiond <guillaume.melquiond@gmail.com>2006-12-29 17:30:40 +0000
committerGuillaume Melquiond <guillaume.melquiond@gmail.com>2006-12-29 17:30:40 +0000
commit3daa119340a6541ccc751bfba22f851e5c2effbb (patch)
tree56b16dd17881c2001d4e7007fc4ad223408e6c45 /README
parent1945e356d63057dee8563c4ad64a877132e5c480 (diff)
downloadmanaserv-3daa119340a6541ccc751bfba22f851e5c2effbb.tar.gz
manaserv-3daa119340a6541ccc751bfba22f851e5c2effbb.tar.xz
manaserv-3daa119340a6541ccc751bfba22f851e5c2effbb.zip
Improved documentation a bit.
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 26 insertions, 12 deletions
diff --git a/README b/README
index 0536db5..c701c20 100644
--- a/README
+++ b/README
@@ -4,17 +4,31 @@ Setting up a TMW server
The compilation should produce two binaries: tmwserv-account and
tmwserv-game.
-Run tmwserv-account on one single computer. It will open three
+1. Run tmwserv-account on one single computer. It will open three
consecutive UDP ports, starting from the one given by the configuration
-option "accountServerPort" (default value: 9601). This first port is the
-one you should give to your users.
+option "accountServerPort". This first port is the one you should
+advertise to your users. The configuration option "accountServerAddress"
+should contain the public address the server runs on, as it will be sent
+to the users as the address of the chat server, which happens to be the
+account server for now.
-Run tmwserv-game on multiple computers. Each game server will open one
-UDP port given by the configuration option "gameServerPort" (default
-value: 9604). It will also connect to the account server given by the
-configuration options "accountServerAddress" (default value: localhost)
-and "accountServerPort". The configuration option "gameServerAddress"
-should contain the public address of the computer the server runs on, as
-it will be sent to the users. The file data/maps.xml contains the maps
-the server will load and register on the account server; split it
-across your multiple game servers, in order to balance the load.
+2. Run tmwserv-game on multiple computers. Each game server will open
+one UDP port given by the configuration option "gameServerPort". It will
+also connect to the account server given by the configuration options
+"accountServerAddress" and "accountServerPort". The configuration option
+"gameServerAddress" should contain the public address of the computer
+the server runs on, as it will be sent to the users. The file
+data/maps.xml contains the maps the server will load and register on the
+account server; split it across your multiple game servers, in order to
+balance the load.
+
+Access to port "accountServerPort + 1" of the account server can be
+restricted to connections from game servers only. Users do not need to
+access it.
+
+Default option values:
+
+ accountServerAddress localhost
+ accountServerPort 9601
+ gameServerAddress localhost
+ gameServerPort 9604