Admin Usage DE - GermanHydrogen/Registration-Bot GitHub Wiki

Eventerstellung

Channel

Channelname: [Datum]-[Bezeichner] (z.B 2019-10-15-arma3)
Enhält Nachricht mit Eventstart: [Zeit] im Zeitformat [hh:mm]

Slotliste

Beginnt mit ">Slotliste<"
Jeder Slot nimmt eine Zeile ein
Ein Slot ist aufgebaut aus #[Nummer] [Beschreibung] -
Das "-" am Ende ist wichtig
Zwischen den Slots kann ebenfalls noch Text - wie Gruppennamen - stehen

Beispiel

>Slotliste<

#01 CO - 
#02 XO - 

Hammer Squad
#03 Squadleader -
#04 Fireteamlead -

Discord Zeichenlimit

Der Bot unterstützt die Aufteilung der Slotliste in mehrere Teil-Nachrichten, um das 2000 Zeichenlimit zu umgehen. Dazu muss jede Teil-Slotliste mit "Slotliste" beginnen.
Der Slotbot teilt die Slotliste dann eigenständig auf, wobei dieser die vorraussichtliche Länge der Slots beachtet, also die Länge der Slotliste, wenn diese mit Anmeldungen gefüllt wurde.

Hinweis I: Die Länge der einzelnen Slotgruppen (Absätze) sollte deutlich kleiner als 2000 Zeichen sein.

Abschließend

Zum Initialisieren des Bots !create ausführen.

Automatische Slotnummer-Generation

Wird !create ohne Argument aufgerufen, werden Slots mit der Nummer 0 (und alle Variationen, also auch 00, 000, ...) automatisch versucht der "richtigen" Slotnummer zuzuordnen. Somit können die Nummern für die Slots vollständig automatisch generiert werden.

Möchte man explizit die Slotnummer 0 verwendet, muss !create manuel aufgerufen werden!

Hinweis:

#00 CO -
#01 XO -

Dies würde zu einem Konflikt führen, da dem erstem Slot die Nummer 01 zugeornet wird.

Managment

Aufbau einer Slotliste aus der Sicht des Bots

Der Bot sieht die Slotliste als Liste von Gruppen mit den Eigenschaften:

Überschrift
Leerzeilen vor der Gruppe
Slots

Hierbei sind Überschriften optional, wie in Gruppe 1 im Bsp.
Freitext wird als Gruppe ohne Slots interpretiert, dieser kann jedoch nicht nachträglich hinzugefügt werden.

Slotliste bearbeiten

Sperren

Befehl: !toggleLock Sperrt/Entsperrt die Slotliste, wodurch Nutzer dem Event nicht mehr beitreten können, aber die Slotliste noch einsehen können.

Hinweis: Nutzer können trotzdem via Kampagnen-Anfrage beitreten.

Gruppen

Befehl	Argument	Beschreibung
!addgroup	[Index] [Name]	Fügt eine Gruppe hinzu
!editgroup	[Name] [neuer Name]	Ändert den Namen einer Gruppe
!delgroup	[Name]	Löscht die angegebenen Gruppe

Anmerkung zu Add: Man kann die Reserveslots ignorieren; der Bot verschiebt diese gegebenenfalls.
Anmerkung zu Edit und Delete: Statt dem Namen, kann auch der Index der Gruppe verwendet werden (Der Bot beginnt bei 0 zu zählen!)

Slots

Befehl	Argument	Beschreibung
!addslot	[Nummer] [Gruppe] [Beschreibung]	Fügt eine Slot zu einer Gruppe hinzu
!delslot	[Nummer]	Löscht den angegebenen Slot
!editslot	[Nummer] [Beschreibung]	Ändert die Beschreibung des Slots

Anmerkung zu Add: Falls der Gruppenname ein Leerzeichen enthält, muss der Index der Gruppe verwendet werden (Der Bot beginnt bei 0 zu zählen!)

Nutzer

Befehl	Argument	Beschreibung
!forceslot	[Slot] [Name]	Trägt einen Nutzer in den Slot ein
!forceunslot	[opt] [arg]	Trägt einen Nutzer aus oder macht den angegebenen Slot frei, je nach Option (--user oder --slot)

Datum und Zeit

Befehl	Argument	Beschreibung
!update	[args]	Aktualisiert die Eventzeit und Datum, und benachrichtigt die eingetragenen User (bzw. nicht mit --suppress)

Automatismen

Sind alle Plätze des Events belegt, legt der Bot automatisch 10% Reserveslots an. Werden dann wieder Plätze frei, rückt der Bot, in die Reserve eingetragene Nutzer nach.

Import von Slotlisten / Kampagnen

Für zwei ähnliche Events (z.B. Kampagne) können, wenn die Slotlisten gleich sind, Nutzer übernommen werden.

Dazu muss der Befehl: !campaign [event] bei dem nachfolgendem Event, dessen Slotliste schon initialisiert wurde, ausgeführt werden. Im Argument wird das Event angegeben, aus dem die Nutzer importiert werden sollen, wobei der Name des Events oder die ID verwendet werden kann.
Nach Ausführen erhalten alle Teilnehmer (Reserve-Slots werden ignoriert) aus dem importierten Event eine Nachricht, sodass sie 2 Tage Zeit haben, um zu- oder abzusagen; dies geschieht über die Discord-Reaktionen.
Während dieser Zeit werden die Slots, wo sich die Nutzer noch nicht entschieden haben geblockt; bei Zusage werden sie automatisch eingetragen, bei Absage wird der Slot wieder freigegeben. Sollte ein Teilnehmer sich bis zum Auslaufen der Zeit nicht entschieden haben, wird er automatisch ausgetragen.

Wichtig: Die Slotliste in welche importiert werden soll, muss die gleichen Slots (Slot-Nummern) besitzten, wie die, aus der importiert wird. Darüber hinaus kann erstere auch mehr Slots besitzen.