From 5cdf8777dc6d6970c87c82d39dfb312c950e344d Mon Sep 17 00:00:00 2001 From: Justin Hawkins Date: Sat, 21 Nov 2020 20:43:51 +1030 Subject: [PATCH] Update readme and remove some old comments --- README.md | 20 +++++++++++++++----- cmd/openttd_multitool/openttd_multitool.go | 5 ----- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 46aabe0..04ba6ca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # openttd-admin -This is a Golang interface to an OpenTTD server, and a standalone 'openttd_multitool' binary +This is a Golang interface to an OpenTTD server, and a standalone 'openttd_multitool' binary for simple, periodic server operations. The latter might include periodically: @@ -9,9 +9,15 @@ The latter might include periodically: * saving the game to a custom, datestamped save * generating datestamped screenshots +## admin.go library + +At the moment the library has limited support for anything except managing +responses to date changes. Please tell me your use case and I will be happy +to look at extending it further. Or, pull requests accepted :-) + ## openttd_multitool -The openttd_multitool connects to the OpenTTD Admin port (default 3977) +The openttd_multitool connects to the OpenTTD Admin port (default 3977) and stays connected. It monitors the game date, and performs your custom commands at periodic intervals. @@ -23,6 +29,11 @@ Possible intervals are: These intervals are obviously in game time! +## running + +The tool is a command line driven executable. It does not require installation. +Just copy it somewhere and run it. + You can configure the tool to send any command that you would type at the OpenTTD console. Here are a few examples: @@ -40,10 +51,9 @@ This saves the game once per month, with a filename like "mygame-2020-11.sav". This generates a screenshot once per year of the entire map, with a name like "screenshot-20201121.png". NOTE that your OpenTTD server needs to support generating screenshots (some dedicated servers compiled without -graphics will not work) and the appropriate graphics packs need to also be installed. +graphics will not work) and the appropriate graphics packs need to also be installed. Additionally, when using the "screenshot giant" command, the entire server will freeze for that time, almost -certainly kicking off all clients, unless your map is very small or your server is very very fast! +certainly kicking off all clients, unless your map is very small or your server is very very fast! No harm is done in that case, they can just reconnect after the screenshot is finished. - diff --git a/cmd/openttd_multitool/openttd_multitool.go b/cmd/openttd_multitool/openttd_multitool.go index acd1b8b..1982c7a 100644 --- a/cmd/openttd_multitool/openttd_multitool.go +++ b/cmd/openttd_multitool/openttd_multitool.go @@ -7,17 +7,12 @@ import ( "os" ) - -// ./openttd_multitool --monthly "say \"hi it is a new month\"" --daily "say \"wow a new day %D" - const currentVersion = "0.02" type dailyFlags []string type monthlyFlags []string type yearlyFlags []string - - func (i *dailyFlags) String() string { // change this, this is just can example to satisfy the interface return "my string representation"