Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.13 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.13 KB

The Adam Malkocich moderation/user help bot made for the PrimeHack Discord.

Examples

Auto Response

Manually Triggering

Here is an example/guide on how to make an auto-reponse topic.

Commands

Basic Topic Commands

  • addTopic [topic] Adds the topic.
  • removeTopic [topic] Removes the topic
  • getTopic [topic] Displays the moderator view for the topic
  • listTopics Lists all topics

Topic Configuration

  • setAnswer [topic] [answer] Assigns an answer/description to the topic

  • setAliases [topic] [alias 1 alias2 alias3] Sets the aliases/alternative commands.

  • addPattern [topic] [pattern] Adds a Regex Pattern to the detector

  • removePattern [topic] [index] Removes a Regex Pattern from the detector

  • addChannel [topic] [pattern] Adds a Regex Pattern to the detector

  • removeChannel [topic] [index] Removes a Regex Pattern from the detector

Moderator Commands

  • warn [user] [reason] Warns a user for the specified reason, and issues a punishment.
  • warns [user] Lists a user's past warnings

Miscellaneous Commands

  • commands Shows this list

  • ping Pong!

  • gateReactRole [message-id] [@role|role-id] [emote-name|emote-id] Adds a specified reaction to a specified message, when this reaction is clicked it will add the specified role. This is designed to grant entry to a server.

primebot.cfg

  • token Place your bot token here.
  • bot-controller Add the ID of the Role which you want to be able to use moderator commands. You can add this multiple times to add multiple roles
  • gate-emote The unicode emote to be used in the gateway
  • gate-role-id This role issued by the gateway button.
  • botlog-channel-id The channel for the bot to user for logging (currently only errors)

topics.cfg

This file is where topics are stored. Refer to the commands to modify this.

Build Requirements

  • JavaSE/JRE 1.8
  • Maven
  • Eclipse (might not be required but it was built for eclipse)