Cleanup repo with some directories

1 files changed, 74 insertions, 0 deletions

diff --git a/doc/CrServerManager.conf.README b/doc/CrServerManager.conf.README
new file mode 100644
index 0000000..34a36be
--- /dev/null
+++ b/doc/CrServerManager.conf.README
@@ -0,0 +1,74 @@
+Als Beispiel ist die Konfiguration von "[DER]Server" unter dem Namen "CrServerManager.conf" beigelegt.
+Sie kann als Ausgangskonfiguration verwendet werden.
+Sie kann aber nicht wie angegeben direkt verwendet werden.
+Alternativ kann der ServerManager ohne existierende Config-Datei gestartet werden, damit dieser eine erstellt.
+
+Die Konfigurationsdatei für den CrServerManager muss "CrServerManager.conf" heißen und sollte wie folgt aufgebaut sein:
+
+Normale Parameter haben die Form:
+ Parametername = belibiege Zeichenkette gehend bis zum Ende der Zeile.
+
+Listen haben die Form:
+ Listenname += Listeneintrag
+
+Maps haben die Form:
+ Mapname[Key] = Value
+
+Werden die Operatoren für Liste und normalen Parameter vertauscht, werden diese nicht richtig verwendet!
+
+Damit alles funktioniert müssen gewisse Parameter die entsprechende Form aufweisen (in Klammer angegeben):
+ o Boolean - Parameter muss entweder true oder false sein!
+ o Integer - Parameter muss eine ganze Zahl sein!
+ o String  - Beliebige Zeichenkette
+
+Die Konfigurationsdatei wird vom ServerManager beim Beenden und Speichern der Einstellungen überschrieben. Dabei 
+werden die Einträge alphabetisch sortiert und Normale Werte, Listen und Maps durch eine Leerzeile getrennt.
+
+Aktuell vorhandene Konfigurationsmöglichkeiten:
+ o Arguments            (String)  - Argumente die an die Clonk-Executable übergeben werden. Am Ende wird das aktuelle Szenario automatisch angehängt.
+ o ClonkConfig          (String)  - Konfigurationsdatei für Clonk. Aus dieser Datei wird unter anderem der eigene Chat-Nick ausgelesen. der Parameter /config:<ClonkConfig> wird automatisch zu den Clonk Argumenten hinzugefügt.
+ o ServerExecutable     (String)  - Pfad zur Clonk-Executable. Bitte absoluten Pfad angeben!
+ o UserListLength       (Integer) - Maximale Länge der Szenario-Warteschlange
+ o Moderators           (Liste aus Integer im CUID-Format) - Liste aus CUIDs der entsprechenden Moderatoren. Ein Moderator kann alles was ein Rundenadmin kann und hat Kickschutz vor Rundenadmins.
+ o IgnoreFolders        (Liste aus Strings)                - Liste aus Ordnern und .lst Dateien die nicht aufgelistet werden sollen. (Ohne .lst-Endung)
+ o AutoHost             (Boolean) - Falls true werden Szenarios aus scenarios.lst automatisch der Reihe nach gehostet, wenn die Wunschliste leer ist. Bei false kann nur über den IRC gehostet werden.
+ o EmptyTimer           (Integer) - Wenn der letzte Client die Lobby verlässt wird ein Countdown mit dieser Zeit gestartet, wenn der aktuelle Countdown nicht bereits darunter liegt.
+ o ManagementPort       (Integer) - Port auf dem das Management-Interface läuft (läuft nur auf localhost).
+ o MaxScenWishes        (Integer) - Gibt an wie oft dasselbe Szenario in der Wunschliste sein darf.
+ o MaxUserWishes        (Integer) - Gibt an wie viele Wünsche vom gleichen Spieler in der Liste sein dürfen.
+ o RandomizeAutoHosting (Boolean) - Wenn true, werden die Einträge aus scenarios.lst in zufälliger Reihenfolge gehostet.
+ o RegainAdminTime      (Integer) - Zeit die ein geleavter Rundenadmin hat, in der er nach einem Rejoin den Admin zurückerlangen kann obwohl bereits jemand anders Admin wurde.
+ o Alias                (Map aus Strings)                  - Beinhaltet die Szenario-Aliase in der Form Alias[Aliasname] = Szenariodatei
+
+IRC-bezogen:
+ o UseIrc             (Boolean) - Bei true wird der IRC Bot aktiviert. Ansonsten nicht.
+ o IrcServer          (String)  - Server mit dem sich der IRC Bot verbinden soll. Bitte darauf achten, dass auf dem Server Bots erlaubt sind!
+ o IrcNick            (String)  - Nickname für den Server
+ o IrcPassword        (String)  - Passwort, falls der Nick registriert ist.
+ o IrcRealName        (String)  - Angezeigter Echter Name im IRC.
+ o IrcChannel         (String)  - Channel in dem der Bot sich aufhalten soll.
+ o IrcIngameChannel   (String)  - Channel in dem die IngameChat-Verbindung stattfindet.
+ o IrcQuitMessage     (String)  - QuitMessage die der ServerManager beim ordnungsgemäßen Beenden verwenden soll.
+ o IrcModerators      (Liste aus Strings) - Eine Liste aus IRC-Nicks die Moderatoren sind. Die Moderatorrechte werden nur aktiv wenn der Nick beim NickServ registriert ist und als authentifiziert angegeben ist.
+ o IrcReconnectDelay  (Integer) - Delay zwischen Verbindungsabbruch und Reconnectversuch (wird an communi weitergegeben).
+ o IrcScenListMessage (String)  - Nachricht die beim Eingabe des list-Befehls im IRC ausgegeben wird (zB ein Link zur Online-Liste).
+ o IrcUseIngameChat   (Boolean) - Legt fest ob die IngameChat-Verbindung aktiviert ist.
+
+Clonkchat-bezogen:
+ o AntiFloodCount  (Integer) - Maximale Anzahl an Nachrichten pro Zeit
+ o AntiFloodTime   (Integer) - Zeit auf die sich die Count-Angabe bezieht. Bei Überschreitung wird der Autor der Nachrichten gekickt.
+
+Automatisch gesetzte Werte:
+ o ClonkDirectory (String) - Pfad in dem der Server mit den Spieldaten liegt (wird aus der ServerExecutable ermittelt)
+ o ServerNick     (String) - Clonk-Chatname, der aus der Clonk-config ermittelt wird.
+ o ServerPCName   (String) - Clonk-PC-Name, der aus der Clonk-config ermittelt wird.
+ o ReattachId     (String) - Eine zufällige ID unter dieser der ProcessManager läuft. Sollte der ProcessManager unerwartet beendet werden (durch SIGKILL oder durch einen Systemabsturz) sollten die FIFO-Dateien mit de Namen "CRSM-Clonkserver-<ID>-(ctrl(in|out)|std(in|out|err))" gelöscht werden. Zusätzlich kann der Config-Eintrag entfernt werden. Ansonsten bleibt der ServerManager beim Verbindungsversuch mit dem nicht mehr existierenden ProcessManager stehen.
+
+Veraltete Werte:
+ Readline-bezogen:
+  o ServerUsesReadline    (Boolean) - Auf true setzen, wenn der Clonk-Server readline aktiviert hat. Dabei wird _versucht_, dass die eigenen Eingaben die durch Readline ausgegeben werden zu vermeiden.
+  o ReadlinePromptEnabled (Boolean) - Auf true setzen, wenn für readline eine Prompt eingestellt ist (das ist normalerweise das "> " in der Eingabezeile des dedizierten Servers)
+  o ReadlineRereadLimit   (Integer) - Limit, wie viele Zeichen der Serverausgabe gebuffert werden und mit der Eingabe verglichen werden. (Höheres Limit -> weniger doppelt ausgegebene Eingaben, dafür schlechtere Performance)
+  Hintergrund:
+   Readline formatiert die Eingabe und gibt sie auf stdout wieder aus. Das führt dazu, dass der ServerManager seine eigenen Eingaben (die Befehle die er an Clonk sendet) lesen muss. Das führt zu teils mehrfacher Ausgabe der Befehle auf der Serverkonsole.
+   Mit den oben angegebenen Optionen wird diese mehrfache Ausgabe vermieden. Bei Verwendung von Sonderzeichen funktioniert das aber nicht zuverlässig.