diff options
| -rw-r--r-- | scripts/autoexec.scr.example | 6 | ||||
| -rw-r--r-- | scripts/readme.txt | 20 |
2 files changed, 20 insertions, 6 deletions
diff --git a/scripts/autoexec.scr.example b/scripts/autoexec.scr.example new file mode 100644 index 000000000..3057ea971 --- /dev/null +++ b/scripts/autoexec.scr.example @@ -0,0 +1,6 @@ +# +# send chat messages from the console with +# +# ] s i love this chat +# +alias "s" "say %!"
\ No newline at end of file diff --git a/scripts/readme.txt b/scripts/readme.txt index 8c126a3a2..0248c4326 100644 --- a/scripts/readme.txt +++ b/scripts/readme.txt @@ -3,12 +3,20 @@ Scripting OpenTTD supports scripts. - - 'on_client.scr' is executed when you join a server as client - - 'on_server.scr' is executed when you start a server / dedicated server - - 'on_dedicated.scr' is additionally executed when you start a dedicated server - - 'pre_server.scr' is executed before the server is started - - 'pre_dedicated.scr' is additionally executed when you start a dedicated server - - 'autoexec.scr' is executed on gamestart [use this for custom aliases per ex.] +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. |