summaryrefslogtreecommitdiff
path: root/bin/scripts/readme.txt
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2007-01-02 19:19:48 +0000
committerrubidium <rubidium@openttd.org>2007-01-02 19:19:48 +0000
commit66bbf336c6af7353ef0aeed58002c46543b30635 (patch)
treead4a63860df2626b22f77e7dac712e958bea54cb /bin/scripts/readme.txt
parentccc0a3f4dbf58c005b22341ac8874252924690cd (diff)
downloadopenttd-66bbf336c6af7353ef0aeed58002c46543b30635.tar.xz
(svn r7759) -Merge: makefile rewrite. This merge features:
- A proper ./configure, so everything needs to be configured only once, not for every make. - Usage of makedepend when available. This greatly reduces the time needed for generating the dependencies. - A generator for all project files. There is a single file with sources, which is used to generate Makefiles and the project files for MSVC. - Proper support for OSX universal binaries. - Object files for non-MSVC compiles are also placed in separate directories, making is faster to switch between debug and release compiles and it does not touch the directory with the source files. - Functionality to make a bundle of all needed files for for example a nightly or distribution of a binary with all needed GRFs and language files. Note: as this merge moves almost all files, it is recommended to make a backup of your working copy before updating your working copy.
Diffstat (limited to 'bin/scripts/readme.txt')
-rw-r--r--bin/scripts/readme.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/bin/scripts/readme.txt b/bin/scripts/readme.txt
new file mode 100644
index 000000000..2927dcdcb
--- /dev/null
+++ b/bin/scripts/readme.txt
@@ -0,0 +1,21 @@
+Scripting
+---------
+
+OpenTTD supports scripts.
+
+local scripts:
+ - 'autoexec.scr' is executed on gamestart [all - use this for custom aliases per ex.]
+
++network scripts:
+ should be used to set client optimization settings:
+ - 'on_client.scr' is executed when you join a server [all clients]
+
+ should be used to set the servers port/ip and/or server optimization settings/patches:
+ - 'pre_server.scr' is executed before the servers tcp stack is started [in-game only]
+ - 'pre_dedicated.scr' is executed before the servers tcp stack is started [dedicated only]
+
+ should be used to set the servers name, password and so on:
+ - 'on_server.scr' is executed after starting a server [dedicated and in-game]
+ - 'on_dedicated.scr' is additionally executed after starting a server [dedicated only]
+
+For examples how a script can look, check the .example examples.