Browse Source

Added descriptive README text

nosoop 7 years ago
parent
commit
d00260c55e
1 changed files with 21 additions and 2 deletions
  1. 21 2
      README.md

+ 21 - 2
README.md

@@ -1,3 +1,22 @@
-# CSRD-UptimeLimiter
+# Uptime Limiter
 
-Restarts the server when it's lived past a certain amount of time.
+Restarts the server when it's lived past a certain amount of time.
+
+For some reason, SourceTV seems to like leaking memory.
+
+Have to kill the server occasionally, but I'm not going to do that when people are around.
+
+As the server primarily runs bots when idle, the plugin uses `TF2_OnWaitingForPlayersStart()`
+to detect an appropriate time to restart.  Therefore, this plugin won't work on servers that do
+not run bots.
+
+## A "CSRD Internal" Plugin
+
+This is a plugin mainly intended for use in [Pikachu's Canadian Server of Romance and
+Drama][csrd].
+
+While I'm happy if you find some useful code for your own plugins, I can't provide any support
+for said code, nor will I offer any guarantees that the plugin will remain usable outside of its
+main use.
+
+[csrd]: https://csrd.science/