Skip to content

Commands

Jump to bottom
Gerald Siegert edited this page Aug 24, 2020 · 59 revisions

Full command reference

Bot Management

Commands provided from the bot management core plugin.

General

  • about, git or github: Prints the credits.
  • plugins: List all current loaded plugins.
  • reload [plugin_name]: Reloads the configuration of the given plugin, or if no plugin given, from all plugins. Can only be used by admin and botmaster role.

Monitoring

  • subsys: Lists registrations on subsystems.

Ignoring Subsystem

For all disable commands: The time ([#m|#h|#d|DD.MM.YYYY|HH:MM|DD.MM.YYYY HH:MM|DD.MM. HH:MM]) can be a fixed date and/or time or a duration after that the command will be auto-removed from the ignore list. The duration unit must be set with trailing m for minutes, h for hours or d for days. If no time is given, the user can't interact with that command unless it will be re-enabled manually. If a user wants to interact or command on the blacklist will be used, the bot doesn't response anything, like the command wouldn't exists.

  • !disable user <user>: Adds a user to bot's ignore list to block any interaction between the user and the bot. Admins and Botmasters only.
  • !disable cmd <command>: Adds a command to bot's ignore list to disable it in current channel. The command name must be the full qualified name of the command without command prefix. If a subcommand should be blocked, the command name must be inside quotation marks like "disable cmd". Admins and Botmasters only.
  • disable <command> [user] [time]: Adds a command to users ignore list to disable any interactions between the user and the command. To block command usage for the user, the command name must be the full qualified name of the command without command prefix. If a subcommand should be blocked, the command name must be inside quotation marks like "disable cmd". To block other interactions than command usage itself, the command must support blocking usage for specific users. Users can disable command interactions for themselves only, but Admins and Botmasters also for other users.
  • disable list: Lists all blocked users and commands
  • enable user <user>: Removes a user from bot's ignore list to enable any interaction between the user and the bot. Admins and Botmasters only.
  • enable cmd <command>: Removes a command from bot's ignore list to enable it in current channel. The command name must be the full qualified name of the command without command prefix. If a subcommand should be enabled, the command name must be inside quotation marks like "enable cmd". Admins and Botmasters only.
  • enable <command> [user]: Removes a command from users ignore list to enable any interactions between the user and the command. Users can enable command interactions for themselves only, but Admins and Botmasters also for other users.

Version control

  • version returns the current version the bot is running.
  • news returns the latest release notes. This is not necessarily the version the bot is running.
  • update check checks if there is a new version that the bot could be updated to.
  • update updates the Bot to the newest version (if available). This includes a shutdown, so be careful. Admins and botmasters only.
  • replace On !update, the bot asks for a confirmation. This is it.
  • restart Restarts the bot.
  • shutdown Stops the bot.

Role Management

Provides the bot role management and self-assignable roles via reactions. Further information about the plugin see the wiki page.

  • !role <user> <add|del> <role>: Adds or removes the role to or from users roles. Only usable for users with corresponding mod role. Admins and Botmaster can add/remove all roles including roles which aren't in the role management.
  • !role add <role_name> [emoji|modrole] [color]: Creates a new role on the server with the given management data. If an emoji is given, the role will be self-assignable by the users via reaction in the role init message. If a mod role is given, a user with the mod role can add/remove the role via !role <user> <add|del> <role>. If the role already exists, it will be added to the role management with the given data. If role is already in the role management, the management data will be updated. As color a color name like 'blue' can be given or a hexcode like '#0000ff'. Admins and Botmaster only.
  • !role del <role>: Deletes the role from the server and role management. Admins and Botmaster only.
  • !role request <role>: Pings the roles corresponding mod role, that the executing user requests the given role.
  • !role update [message_content]: Updates the role management from server data and removes deleted roles from role management. If a message content is given, this message will be used for the role management init message text. Before using the role management, the channel must be set via !role update channel=<channel>. Admins and Botmaster only.
  • !role untrack <role>: Removes the role from the role management, but not from server. Admins and Botmaster only.

Custom Commands

Adds, list or removes a custom command. Custom commands can be added and removed in runtime. To use a custom command, the message must start with the setted prefix, which can be returned using the prefix subcommand.

  • cmd add <cmd name> <text...>: Adds a custom command or a new output text for an existing command. Following wildcards can be used, which will be replaced on using:
    %u: The user who uses the command
    %um: Mentions the user who uses the command
    %n: The nth command argument
    %n*: The nth and all following arguments
    %a: Alias for %1*
    Supports /me. Custom commands must be compliant to the general command guidelines, which can be accessed via !cmd guidelines. Example: !cmd add test Argument1: %1 from user %u
  • cmd del <cmd_name> [text_id]: Deletes a custom command or one of its output texts. If the last output text was deleted, the whole command will be removed. To delete a output text, the ID of the text must be given. The IDs and creator can be get via !cmd info .Only the original command creator or admins can delete commands or its texts.
  • cmd guidelines: Returns the link to the general command guidelines
  • cmd info <cmd_name>: Gets full info about a command
  • cmd list [full]: Lists all custom commands
  • cmd prefix [new_prefix]: Returns or sets the custom command prefix. Only admins and botmasters can set a new prefix which mustn't be the same like for regular commands.

DSC

Provides management and information commands for DSC

  • dsc: Base command, if no subcommand invoked, dsc info will be executed.
  • dsc info: Returns base infos about current/next DSC. Displays host and registration file link, on voting phase also the Youtube playlist link. If phase ending date is in past, no date will be displayed.
  • dsc rules: Returns the link to the DSC rules file. Alias: dsc regeln.
  • dsc winners: Gets previous DSC winners
  • dsc set config: Gets or sets general config values for the plugin. Can only be used by songmaster, admin and botmaster role.
  • dsc set date <DD.MM.JJJJ> [HH:MM]: Sets the end date for current phase. Must be a valid date and time. If no time is given, 23:59 will be used. Can only be used by songmaster, admin and botmaster role.
  • dsc set host <user>: Sets the host of current/next DSC to given user. Can only be used by songmaster, admin and botmaster role.
  • dsc set points: Sets the point list for the current voting system. Points can be set like "12-10-..." or "12 10 ...", which will be converted to the first. Can only be used by songmaster, admin and botmaster role.
  • dsc set state <registration|voting>: Sets the current DSC phase to registration or voting. Can only be used by songmaster, admin and botmaster role.
  • dsc set status [message]: Sets a status message for additional informations. To remove give no message. Can only be used by songmaster, admin and botmaster role.
  • dsc set yt: Sets the Youtube playlist link. Can only be used by songmaster, admin and botmaster role.

Wer bin ich

  • werbinich: Startet ein neues Wer-bin-ich-Spiel. Nach einer Registrierungsphase via Reactions ordnet der Bot jedem Spieler einen anderen zu und fordert dann alle Spieler per PN auf, für ihren zugeordneten Spieler einen Namen zu nennen. Haben alle Spieler dies getan, tut der Bot allen Spielern die Liste der ausgewählten Namen (mit Ausnahme des jeweiligen Spielers) kund, auf dass ein Spiel beginnen kann. Für die Auswahlphase gibt es keinen Timeout o.ä.
  • werbinich status: Status des momentan laufenden Spiels, insbesondere Nennung aller Spieler, die noch keinen Namen genannt haben.
  • werbinich stop: Stoppt das momentan laufende Spiel.
  • werbinich spoiler: Zuschauer-Kommando, mit dem diese das letzte Spiel erfragen können.

DSC

Provides management and information commands for NFL Fantasy Leagues

  • fantasy: Base command, if no subcommand invoked, fantasy info will be executed.
  • fantasy info: Get information about the NFL Fantasy Game
  • fantasy status: Get the current information about the current fantasy state
  • fantasy link: Get the link to the Fantasy Leagues
  • fantasy set config: Gets or sets general config values for the plugin. Can only be used by manager role, admin and botmaster role.
  • fantasy set date <DD.MM.JJJJ> [HH:MM]: Sets the end date and time for all the phases. If no time is given, 23:59 will be used.. Can only be used by manager role, admin and botmaster role.
  • fantasy set del <number>: Removes league #. Can only be used by manager role, admin and botmaster role.
  • fantasy set comm <number> <commissioner>: Sets the commissioner for the league #. Can only be used by manager role, admin and botmaster role.
  • fantasy set state <sign_up|predraft|preseason|regular|postseason|finished>: Sets the Fantasy state. Possible states: Sign_Up, Predraft, Preseason, Regular, Postseason, Finished. Can only be used by manager role, admin and botmaster role.
  • fantasy set status [message]: Sets a status message for additional information. To remove give no message.
  • fantasy set orga <organisator>: Sets the Fantasy Organisator. Can only be used by manager role, admin and botmaster role.
  • fantasy set datalink <link>: Sets the link for the Players Database. Can only be used by manager role, admin and botmaster role.
  • fantasy set link <number> <link>: Sets the link for the league #. If the league doesn't exist, a new league will be added. Can only be used by manager role, admin and botmaster role.

Feedback

  • complain message delivers a feedback message. The admins and botmasters can then read the accumulated feedback. The bot saves the feedback author, the message and a link to the message for context.
  • redact [del x] returns the accumulated feedback. Use del x to delete feedback #x. Admins and Botmasters only.

Kwiss

Starts a kwiss in the channel.

  • kwiss: Starts a kwiss. Arguments (in any order) (omittable):
    • Method: What to do. Can be start (default), stop, pause, resume, status or score.
    • Amount of questions: Any integer (below the limit). Defines the length of the kwiss round.
    • Question database: Currently only opentdb.
    • Game mode: race or points (Currently only race). For explanations, see below.
    • Difficulty: any, easy, medium or hard
    • Category: Quiz category. Currently, only one category is supported. For a full list of categories, use !kwiss categories. Default is any.
    • Ranked: ranked. The kwiss counts for the ladder.
    • Gecki: gecki. The bot participates.
  • kwiss emoji <emoji>: From now on, the bot uses the emoji emoji as a prefix for your name. Leave emoji empty to remove the prefix.
  • kwiss categories: Prints out a list of all supported categories.
  • kwiss question: Prints information about the current question.
  • kwiss ladder: Prints the current ranked ladder.
  • kwiss del <user>: Removes the user user from the ranked ladder. Admins only.
  • Examples: !kwiss 20 start, !kwiss, !kwiss math, !kwiss 15 points hard

Rush mode

In rush (aka Winner takes it all), the first user who types in the correct answer wins the point of the round. At the end of the kwiss, the user who acquired the most points wins.

Points mode

In points, the kwiss begins with a registration period where all participants have to register via reaction. In every round, every participant has to react with his answer. Every participant whose answer was correct gets a point. At the end of the kwiss, the user who has acquired the most points wins.

Misc

Provides miscellaneous commands.

  • dice [NumberOfSides] [NumberOfDices]: Rolls NumberOfDices dices with NumberOfSides sides and returns the result
  • geck: Returns a picture of Treeckos
  • keysmash: Returns random keysmash.
  • kicker: Returns the kicker tables for Bundesliga, 2. Bundesliga, 3. Liga and Austrian Bundesliga.
  • mimimi: Provides a mp3 file that plays the sound of "mimimi"
  • mud: Returns "kip!"
  • mudkip: Returns a Youtube link to a Mudkip video.
  • remindme <duration|DD.MM.YYYY HH:MM|DD.MM. HH:MM|HH:MM|cancel|list> [message|cancel_id]: Reminds the author in x minutes, hours or days or on a fixed date and/or time or cancels the users reminder with given ids. The duration unit can be set with trailing m for minutes, h for hours or d for days. If none is set, the duration unit is in minutes. Duration example: 5h = 5 hours. If no cancel id is given, all user's reminders will be removed.
  • werwars: Shows who is bullying other users in the last 30 minutes in the current channel. Supports ignore list. Alias: wermobbtgerade

Number Guessing

Starts a guessing game.

  • guess <number>: Enters a guess.
  • guess start: Starts a new single game with range from 1 to 100 if no channel game is active.
  • guess start [channel|single]: Starts a new channel or single game with range from 1 to 100.
  • guess start [channel|single] [Range_From] [Range_To]: Starts a new channel or single game with range from and to. Range needs to be all positive without 0.
  • guess stop: Stops an active game.
  • guess status: Shows the status of all currently active games.
  • guess status all: Shows the status of all currently active games.
  • guess status channel: Shows the status of a currently active channel game in that particular channel.
  • guess status channel all: Shows the status of all currently active channel games.
  • guess status single: Shows the status of a currently active single game of that particular user.
  • guess status single all: Shows the status of all currently active single games.

Note: If a single game is active guesses will always count to that game, no matter if a channel game is active too. In order to participate in a channel game the single game needs to be finished first either through successfully finish guessing or stopping the game.

Channel Games

For playing a round together it is possible to start a channel game in order to enable all members in that channel to enter a guess.

Single Games

In this game mode guessing is only possible for one user.

Testing/Debug

Some testing and debugging commands.

  • identify: Get the name the bot is using to name you

Spaetzle

Provides management and information commands for the Spaetzle-Tippspiel

  • spaetzle duel <user>: Displays the score and predictions of the user's duel.
  • spaetzle duels <league>: Displays the scores of all duels in the specified league.
  • spaetzle duels: Displays the scores of the duels of the observed users.
  • spaetzle info: Shows an info message.
  • spaetzle link: Returns a link to the spreadsheet.
  • spaetzle matches: Displays the matches of the current matchday.
  • spaetzle table <league>: Displays the table of the specified league.
  • spaetzle table <user>: Displays a section of the table around user's position

Observation

Users can be marked for observation to be displayed in spaetzle duels.

  • spaetzle observe list: Returns a list of users currently observed.
  • spaetzle observe add <user>: Adds a user to the observation.
  • spaetzle observe remove <user>: Removes a user from the observation.

User linking

Discord users can link themselves to a specific participant of the Spaetzle-Tippspiel. Linked user don't have to explicitly name their own participant when calling spaetzle duel or spaetzle table.

  • spaetzle user <participant>: Links the discord user to the Spaetzle-participant
  • spaetzle user: Removes the linking.

Future Releases

Note: Commands listed here for future releases are not final. Subject to change.

Clone this wiki locally