diff options
Diffstat (limited to 'bin/scripts/readme.txt')
| -rw-r--r-- | bin/scripts/readme.txt | 21 |
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. |