forked from tgstation/tgstation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Server tools API v3.1 (tgstation#31000)
* New API for service communication * Safer this way * Gives the game the ability to kill itself * tick_lag * Sanity check * Updates comment * Formalization of the server tools API * Fixes, finishes, and cleanup * Remove unecessary scoping * Compile fixes * Didn't Ctrl+S * Reimplement chat commands * Fixup * Required parameters * Fax * Testing * Fix ON_TOPIC * The more defines the more better * That's bass ackwards * Fix tgs2 * Fuck it, call him pichael * Do this * No, we only use the modern methods now * Remove tgs2 relay support * Remove kebab * Kill kill kill * This is back baby * Missed a GLOB * Remove DownloadPRDetails() * Cache custom commands by name * Adds "notify" chat command * Use the official API * Fix API misuse * Readme licensing memes * Fix API * Moves chat new game announcement to when the API is confirmed compatible * Add TGS3.json * Fix the input options * Removes notify command
- Loading branch information
1 parent
bc50c77
commit 62f788f
Showing
17 changed files
with
420 additions
and
292 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "documentation": "/tg/station server 3 configuration file", | ||
| "changelog": { | ||
| "script": "tools/ss13_genchangelog.py", | ||
| "arguments": "html/changelog.html html/changelogs", | ||
| "pip_dependancies": [ | ||
| "PyYaml", | ||
| "beautifulsoup4" | ||
| ] | ||
| }, | ||
| "synchronize_paths": [ | ||
| "html/changelog.html", | ||
| "html/changelogs/*" | ||
| ], | ||
| "static_directories": [ | ||
| "config", | ||
| "data" | ||
| ], | ||
| "dlls": [ | ||
| "libmysql.dll" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,123 @@ | ||
| // /tg/station 13 server tools API v3.1 | ||
|
|
||
| //CONFIGURATION | ||
| //use this define if you want to do configuration outside of this file | ||
| #ifndef SERVER_TOOLS_EXTERNAL_CONFIGURATION | ||
| //Comment this out once you've filled in the below | ||
| //#error /tg/station server tools interface unconfigured | ||
|
|
||
| //Required interfaces (fill in with your codebase equivalent): | ||
|
|
||
| //create a global variable named `Name` and set it to `Value` | ||
| //These globals must not be modifiable from anywhere outside of the server tools | ||
| #define SERVER_TOOLS_DEFINE_AND_SET_GLOBAL(Name, Value) GLOBAL_VAR_INIT(##Name, ##Value); GLOBAL_PROTECT(##Name) | ||
| //Read the value in the global variable `Name` | ||
| #define SERVER_TOOLS_READ_GLOBAL(Name) GLOB.##Name | ||
| //Set the value in the global variable `Name` to `Value` | ||
| #define SERVER_TOOLS_WRITE_GLOBAL(Name, Value) GLOB.##Name = ##Value | ||
| //display an announcement `message` from the server to all players | ||
| #define SERVER_TOOLS_WORLD_ANNOUNCE(message) to_chat(world, "<span class='boldannounce'>[html_encode(##message)]</span>") | ||
| //Write a string `message` to a server log | ||
| #define SERVER_TOOLS_LOG(message) log_world("SERVICE: [##message]") | ||
| //Notify current in-game administrators of a string `event` | ||
| #define SERVER_TOOLS_NOTIFY_ADMINS(event) message_admins(##event) | ||
| #endif | ||
|
|
||
| //Required hooks: | ||
|
|
||
| //Put this somewhere in /world/New() that is always run | ||
| #define SERVER_TOOLS_ON_NEW ServiceInit() | ||
| //Put this somewhere in /world/Topic(T, Addr, Master, Keys) that is always run before T is modified | ||
| #define SERVER_TOOLS_ON_TOPIC var/service_topic_return = ServiceCommand(params2list(T)); if(service_topic_return) return service_topic_return | ||
| //Put at the beginning of world/Reboot(reason) | ||
| #define SERVER_TOOLS_ON_REBOOT ServiceReboot() | ||
|
|
||
| //Optional callable functions: | ||
|
|
||
| //Returns the string version of the API | ||
| #define SERVER_TOOLS_API_VERSION ServiceAPIVersion() | ||
| //Returns TRUE if the world was launched under the server tools and the API matches, FALSE otherwise | ||
| //No function below this succeed if this is FALSE | ||
| #define SERVER_TOOLS_PRESENT RunningService() | ||
| //Gets the current version of the service running the server | ||
| #define SERVER_TOOLS_VERSION ServiceVersion() | ||
| //Forces a hard reboot of BYOND by ending the process | ||
| //unlike del(world) clients will try to reconnect | ||
| //If the service has not requested a shutdown, the world will reboot shortly after | ||
| #define SERVER_TOOLS_REBOOT_BYOND world.ServiceEndProcess() | ||
| /* | ||
| Gets the list of any testmerged github pull requests | ||
| "[PR Number]" => list( | ||
| "title" -> PR title | ||
| "commit" -> Full hash of commit merged | ||
| "author" -> Github username of the author of the PR | ||
| ) | ||
| */ | ||
| #define SERVER_TOOLS_PR_LIST GetTestMerges() | ||
| //Sends a message to connected game chats | ||
| #define SERVER_TOOLS_CHAT_BROADCAST(message) world.ChatBroadcast(message) | ||
| //Sends a message to connected admin chats | ||
| #define SERVER_TOOLS_RELAY_BROADCAST(message) world.AdminBroadcast(message) | ||
|
|
||
| //IMPLEMENTATION | ||
|
|
||
| #define SERVICE_API_VERSION_STRING "3.1.0.0" | ||
|
|
||
| #define REBOOT_MODE_NORMAL 0 | ||
| #define REBOOT_MODE_HARD 1 | ||
| #define REBOOT_MODE_SHUTDOWN 2 | ||
|
|
||
| #define IRC_STATUS_THROTTLE 5 | ||
|
|
||
| #define PR_ANNOUNCEMENTS_PER_ROUND 5 //The number of unique PR announcements allowed per round | ||
| //This makes sure that a single person can only spam 3 reopens and 3 closes before being ignored | ||
|
|
||
| //keep these in sync with TGS3 | ||
| #define SERVICE_WORLD_PARAM "server_service" | ||
| #define SERVICE_VERSION_PARAM "server_service_version" | ||
| #define SERVICE_PR_TEST_JSON "prtestjob.json" | ||
| #define SERVICE_PR_TEST_JSON_OLD "..\\..\\[SERVICE_PR_TEST_JSON]" | ||
| #define SERVICE_INTERFACE_DLL "TGServiceInterface.dll" | ||
| #define SERVICE_INTERFACE_FUNCTION "DDEntryPoint" | ||
|
|
||
| #define SERVICE_CMD_HARD_REBOOT "hard_reboot" | ||
| #define SERVICE_CMD_GRACEFUL_SHUTDOWN "graceful_shutdown" | ||
| #define SERVICE_CMD_WORLD_ANNOUNCE "world_announce" | ||
| #define SERVICE_CMD_IRC_CHECK "irc_check" | ||
| #define SERVICE_CMD_IRC_STATUS "irc_status" | ||
| #define SERVICE_CMD_ADMIN_MSG "adminmsg" | ||
| #define SERVICE_CMD_NAME_CHECK "namecheck" | ||
| #define SERVICE_CMD_ADMIN_WHO "adminwho" | ||
| #define SERVICE_CMD_LIST_CUSTOM "list_custom_commands" | ||
|
|
||
| #define SERVICE_CMD_PARAM_KEY "serviceCommsKey" | ||
| #define SERVICE_CMD_PARAM_COMMAND "command" | ||
| #define SERVICE_CMD_PARAM_MESSAGE "message" | ||
| #define SERVICE_CMD_PARAM_TARGET "target" | ||
| #define SERVICE_CMD_PARAM_SENDER "sender" | ||
| #define SERVICE_CMD_PARAM_CUSTOM "custom" | ||
| #define SERVICE_CMD_API_COMPATIBLE "api_compat" | ||
|
|
||
| #define SERVICE_JSON_PARAM_HELPTEXT "help_text" | ||
| #define SERVICE_JSON_PARAM_ADMINONLY "admin_only" | ||
| #define SERVICE_JSON_PARAM_REQUIREDPARAMETERS "required_parameters" | ||
|
|
||
| #define SERVICE_REQUEST_KILL_PROCESS "killme" | ||
| #define SERVICE_REQUEST_IRC_BROADCAST "irc" | ||
| #define SERVICE_REQUEST_IRC_ADMIN_CHANNEL_MESSAGE "send2irc" | ||
| #define SERVICE_REQUEST_WORLD_REBOOT "worldreboot" | ||
| #define SERVICE_REQUEST_API_VERSION "api_ver" | ||
|
|
||
| /* | ||
| The MIT License | ||
| Copyright (c) 2011 Dominic Tarr | ||
| Permission is hereby granted, free of charge, | ||
| to any person obtaining a copy of this software and | ||
| associated documentation files (the "Software"), to | ||
| deal in the Software without restriction, including | ||
| without limitation the rights to use, copy, modify, | ||
| merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom | ||
| the Software is furnished to do so, | ||
| subject to the following conditions: | ||
| The above copyright notice and this permission notice | ||
| shall be included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
| IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR | ||
| ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | ||
| TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
| SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.