summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsmatz <smatz@openttd.org>2011-01-16 13:36:47 +0000
committersmatz <smatz@openttd.org>2011-01-16 13:36:47 +0000
commit82346d4608929752e23ca87f79c80aba60ec8f9a (patch)
treef22a0c0a9c1eaac0a4b315c674be259faedf8483 /docs
parent32cd182ecc668874efdf9f30760fd67a2d8646c2 (diff)
downloadopenttd-82346d4608929752e23ca87f79c80aba60ec8f9a.tar.xz
(svn r21823) -Documentation: update the style used in several documentation files
Diffstat (limited to 'docs')
-rw-r--r--docs/32bpp.txt18
-rw-r--r--docs/HOWTO_compile_lang_files.txt24
-rw-r--r--docs/admin_network.txt76
-rw-r--r--docs/multiplayer.txt51
4 files changed, 94 insertions, 75 deletions
diff --git a/docs/32bpp.txt b/docs/32bpp.txt
index 1f5e6687f..c8cd6f50d 100644
--- a/docs/32bpp.txt
+++ b/docs/32bpp.txt
@@ -1,15 +1,24 @@
32bpp and OpenTTD
-=================
+Last updated: 2007-06-13
+------------------------------------------------------------------------
+
+Table of contents
+-----------------
+1.0) About
+2.0) The format
+
+
+1.0) About
+---- -----
OpenTTD has 32bpp support. This means: OpenTTD still is 8bpp, but it has the
posibility to override the graphics with 32bpp. This means that it isn't a
replacement of grf or newgrf, but simply an addition. If you want to use 32bpp
graphics of a newgrf, you do need the newgrf itself too (with 8bpp graphics).
-The Format
-----------
-
+2.0) The format
+---- ----------
32bpp images are stored in PNG. They should go in:
data/sprites/<grfname>/<SpriteID>.png
@@ -33,4 +42,3 @@ to add this information. Sadly enough most graphical editors trashes those
chunks upon save, so you have to readd it every time you save your image.
Your images should be the same as the grf, in size.
-
diff --git a/docs/HOWTO_compile_lang_files.txt b/docs/HOWTO_compile_lang_files.txt
index 570381efa..c56f97a62 100644
--- a/docs/HOWTO_compile_lang_files.txt
+++ b/docs/HOWTO_compile_lang_files.txt
@@ -1,5 +1,17 @@
-STRGEN USAGE
-------------
+OpenTTD and strgen
+Last updated: 2009-06-30
+------------------------------------------------------------------------
+
+
+Table of contents
+-----------------
+1.0) strgen usage
+ * 1.1) Examples
+ * 1.2) strgen command switches
+
+
+1.0) strgen usage
+---- ------------
This guide is only interesting for people who want to alter something
themselves without access to translator.openttd.org. Please note that
your compiled language file will only be compatible with the OpenTTD version
@@ -14,8 +26,8 @@ strgen takes as argument a txt file and translates it to a lng file, allowing
it to be used inside OpenTTD. strgen needs the master language file
english.txt to work. Below are some examples of strgen usage.
-EXAMPLES
---------
+1.1) Examples
+---- --------
Example 1:
if you are in the root of your working copy (svn code), you should type
strgen/strgen -s lang lang/english.txt
@@ -35,8 +47,8 @@ resulting language file to go to /tmp. Use
You can interchange english.txt to whichever language you want to generate a
.lng file for.
-STRGEN COMMAND SWITCHES
------------------------
+1.2) strgen command switches
+---- -----------------------
-v | --version
strgen will tell what svn revision it was last modified
diff --git a/docs/admin_network.txt b/docs/admin_network.txt
index b81368e42..4f83f1c6d 100644
--- a/docs/admin_network.txt
+++ b/docs/admin_network.txt
@@ -1,19 +1,23 @@
-Admin Network
+OpenTTD's admin network
+Last updated: 2010-12-30
+------------------------------------------------------------------------
- Preface
-1. Joining the network
-2. Asking for updates
-3. Polling manually
-4. Sending rcon commands
-5. Sending chat
-6. Receiving chat
-7. Disconnecting
-8. Certain packet information
-
-
- Preface
-----------
+Table of contents
+-----------------
+1.0) Preface
+2.0) Joining the network
+3.0) Asking for updates
+ * 3.1) Polling manually
+4.0) Sending rcon commands
+5.0) Sending chat
+ * 5.1) Receiving chat
+6.0) Disconnecting
+7.0) Certain packet information
+
+
+1.0) Preface
+---- -------
The admin network provides a dedicated network protocol designed for other
applications to communicate with OpenTTD. Connected applications can execute
console commands remotely (rcon commands) with no further authentication.
@@ -33,12 +37,11 @@ Admin Network
removed from packets in later versions, except the possibility that complete
packets are dropped in favour of a new packet.
This though will be reflected in the protocol version as announced in the
- ADMIN_PACKET_SERVER_PROTOCOL in section 1.
-
+ ADMIN_PACKET_SERVER_PROTOCOL in section 2.0).
-1. Joining the network
-----------------------
+2.0) Joining the network
+---- -------------------
Create a TCP connection to the server on port 3977. The application is
expected to authenticate within 10 seconds.
@@ -68,9 +71,8 @@ Admin Network
However, ADMIN_PACKET_SERVER_WELCOME only after a ADMIN_PACKET_SERVER_NEWGAME
-2. Asking for updates
----------------------
-
+3.0) Asking for updates
+---- ------------------
Asking for updates is done with ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY.
With this packet you define which update you wish to receive at which
frequency.
@@ -116,9 +118,8 @@ Admin Network
ADMIN_UPDATE_CMD_LOGGING results in the server sending:
- ADMIN_PACKET_SERVER_CMD_LOGGING
-3. Polling manually
--------------------
-
+3.1) Polling manually
+---- ----------------
Certain AdminUpdateTypes can also be polled:
- ADMIN_UPDATE_DATE
- ADMIN_UPDATE_CLIENT_INFO
@@ -138,9 +139,8 @@ Admin Network
Additional debug information can be found with a debug level of net=3.
-4. Sending rcon commands
-------------------------
-
+4.0) Sending rcon commands
+---- ---------------------
Rcon runs separate from the ADMIN_UPDATE_CONSOLE AdminUpdateType. Requesting
the execution of a remote console command is done with the packet
ADMIN_PACKET_ADMIN_RCON.
@@ -158,9 +158,8 @@ Admin Network
was not sent from the admin network.
-5. Sending Chat
----------------
-
+5.0) Sending chat
+---- ------------
Sending a ADMIN_PACKET_ADMIN_CHAT results in chat originating from the server.
Currently four types of chat are supported:
@@ -173,10 +172,8 @@ Admin Network
using the respective DestType and ID.
This is a message prefixed with the 3 stars, e.g. *** foo has joined the game
-
-6. Receiving chat
------------------
-
+5.1) Receiving chat
+---- -------------
Register ADMIN_UPDATE_CHAT at ADMIN_FREQUENCY_AUTOMATIC to receive chat.
The application will be able to receive all chat the server can see.
@@ -184,16 +181,14 @@ Admin Network
private chat for to the server is distributed into the admin network.
-7. Disconnecting
-----------------
-
+6.0) Disconnecting
+---- -------------
It is a kind thing to say good bye before leaving. Do this by sending the
ADMIN_PACKET_ADMIN_QUIT packet.
-8. Certain packet information
------------------------------
-
+7.0) Certain packet information
+---- --------------------------
All ADMIN_PACKET_SERVER_* packets have an enum value greater 100.
ADMIN_PACKET_SERVER_WELCOME
@@ -211,4 +206,3 @@ Admin Network
treated as such. Do not rely on IDs or names to be constant
across different versions / revisions of OpenTTD.
Data provided in this packet is for logging purposes only.
-
diff --git a/docs/multiplayer.txt b/docs/multiplayer.txt
index b85724d46..f38846660 100644
--- a/docs/multiplayer.txt
+++ b/docs/multiplayer.txt
@@ -1,9 +1,21 @@
-Multiplayer Manual for OpenTTD
-==============================
+Multiplayer manual for OpenTTD
+Last updated: 2010-11-30
+------------------------------------------------------------------------
-1. Starting a Server
----------------------
+Table of contents
+-----------------
+1.0) Starting a server
+2.0) Connecting to a server
+ * 2.1) Connecting to a server over the console
+3.0) Playing internet games
+4.0) Tips for servers
+5.0) Some useful things
+6.0) Troubleshooting
+
+
+1.0) Starting a server
+---- -----------------
- Click "multiplayer" on the startup screen
- Click "start server"
- Type in a game name
@@ -14,9 +26,8 @@ Multiplayer Manual for OpenTTD
- Start playing
-2. Connecting to a Server
---------------------------
-
+2.0) Connecting to a server
+---- ----------------------
- Click "multiplayer" on the startup screen
- If you want to connect to any network game in your LAN click on 'LAN', then
@@ -43,17 +54,14 @@ Multiplayer Manual for OpenTTD
- Happy playing
-
-3. Connecting to a Server over the Console
--------------------------------------------
-
+2.1) Connecting to a server over the console
+---- ---------------------------------------
- Open the console and type in the following command:
connect <ip/host>:<port>#<company-no>
-4. Playing Internet-Games
---------------------------
-
+3.0) Playing internet games
+---- ----------------------
- Servers with a red dot behind it have a different version then you have. You
will not be able to join those servers.
@@ -83,9 +91,8 @@ Multiplayer Manual for OpenTTD
NB: changing frame_freq has more effect on the bandwidth then sync_freq.
-5. Tips for servers
---------------------
-
+4.0) Tips for servers
+---- ----------------
- You can launch a dedicated server by adding -D as parameter.
- In UNIX like systems, you can fork your dedicated server by adding -f as
parameter.
@@ -142,9 +149,8 @@ Multiplayer Manual for OpenTTD
#max_clients * #max_clients * bytes_per_frame * 10 KiB.
-6. Some useful things
-----------------------
-
+5.0) Some useful things
+---- ------------------
- You can protect your company so nobody else can join uninvited. To do this,
set a password in your Company Screen
@@ -156,9 +162,8 @@ Multiplayer Manual for OpenTTD
- Servers can now kick players, so don't make them use it!
-7. Troubleshooting
-------------------
-
+6.0) Troubleshooting
+---- ---------------
- My advertising server does not show up in list at servers.openttd.org
Run openttd with the '-d net=2' parameter, as this will show whether it
receives replies from the master server. If it does not receive replies it