diff options
Diffstat (limited to 'bin/scripts')
-rw-r--r-- | bin/scripts/autoexec.scr.example | 4 | ||||
-rw-r--r-- | bin/scripts/on_client.scr.example | 2 | ||||
-rw-r--r-- | bin/scripts/on_dedicated.scr.example | 4 | ||||
-rw-r--r-- | bin/scripts/on_server.scr.example | 3 | ||||
-rw-r--r-- | bin/scripts/pre_dedicated.scr.example | 3 | ||||
-rw-r--r-- | bin/scripts/pre_server.scr.example | 2 | ||||
-rw-r--r-- | bin/scripts/readme.txt | 21 |
7 files changed, 39 insertions, 0 deletions
diff --git a/bin/scripts/autoexec.scr.example b/bin/scripts/autoexec.scr.example new file mode 100644 index 000000000..af1b66d21 --- /dev/null +++ b/bin/scripts/autoexec.scr.example @@ -0,0 +1,4 @@ +# send chat messages from the console with +# ] s i love this chat +# +alias s "say %!"
\ No newline at end of file diff --git a/bin/scripts/on_client.scr.example b/bin/scripts/on_client.scr.example new file mode 100644 index 000000000..5bbd76049 --- /dev/null +++ b/bin/scripts/on_client.scr.example @@ -0,0 +1,2 @@ +echo "Setting default network client settings..." +name = "myname" diff --git a/bin/scripts/on_dedicated.scr.example b/bin/scripts/on_dedicated.scr.example new file mode 100644 index 000000000..5465cd797 --- /dev/null +++ b/bin/scripts/on_dedicated.scr.example @@ -0,0 +1,4 @@ +echo "Setting dedicated network server settings..." +# empty the server password +server_pw = "*" +server_name = "My example dedicated gameserver" diff --git a/bin/scripts/on_server.scr.example b/bin/scripts/on_server.scr.example new file mode 100644 index 000000000..cc799d9e7 --- /dev/null +++ b/bin/scripts/on_server.scr.example @@ -0,0 +1,3 @@ +echo "Setting default network server settings..." +net_sync_freq = 100 +net_frame_freq = 0 diff --git a/bin/scripts/pre_dedicated.scr.example b/bin/scripts/pre_dedicated.scr.example new file mode 100644 index 000000000..b41ca51d2 --- /dev/null +++ b/bin/scripts/pre_dedicated.scr.example @@ -0,0 +1,3 @@ +# set default server port, and have the dedicated server listen on all interfaces +server_ip = all +server_port = 3979 diff --git a/bin/scripts/pre_server.scr.example b/bin/scripts/pre_server.scr.example new file mode 100644 index 000000000..c1b6c822c --- /dev/null +++ b/bin/scripts/pre_server.scr.example @@ -0,0 +1,2 @@ +# set the server port to the default value +server_port = 3979 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. |