diff --git a/src/content/site/bots.md b/src/content/site/bots.md index 4d0f520..94fcdaf 100644 --- a/src/content/site/bots.md +++ b/src/content/site/bots.md @@ -4,53 +4,37 @@ path: /bots This page details the bots you can interact with on our server. There are other bots within the server, but they are strictly for usage by staff. -## HotBot -**Description:** HotBot is the oldest bot on the server. It is slowly being replaced by the newer bots. As of now its main purpose is to provide users with information regarding any infractions/strikes on the server. It also provides macros to users. +## Aura -**Prefix:** `++` or `+` for a self destructing invocation +**Description:** Aura bot will hand out karma to users that earn it. Giving karma is as simple as mentioning (tagging) a user and thanking them in the same message. + +**Source:** https://github.com/the-programmers-hangout/aura + +**Prefix:** `karma!` ### Commands -#### Infractions/strikes +`karma!explain` - Details how the karma system works. -`++selfhistory` - Send this in a Direct Message to HotBot to view your infraction/strike history +`karma!help` - Displays help information. -#### Redirection & Rule reminders +`karma!karma` - Displays your karma. -`++ask` - If a user is looking for DMs, waiting for "experts", or anything else to delay asking their question use this. +`karma!leaderboard` - Displays the karma leaderboard. -`++beginner` - A more verbose version of `++beginners`. +`karma!profile` - Gives a karma breakdown per channel. -`++beginners` - Redirect a user to the beginners channel. Their question has probably been answered there. +`karma!reactions` - Details the reactions that Aura can add to messages. -`++bin` - Hastebin links for long code snippets. - -`++cc` - Redirect a user to our sister server Controversy Central. - -`++hire` - Redirect a user to #projectlistings or #open-source-contributions. - -`++how2ask` - If a user isn't providing enough detail use this. - -`++imageofcode` - Images of code can be really hard to read, let people know they should post the code as text instead. - -`++noresearch` - Research is an important part of programming. Encourage people to research *then* ask! Ask them what they found if anything. - -`++patience` - Remind users not to pester others in channels. - -`++techchoice` - If a user is asking between X and Y tech in a general case, use this. - -`++voice` - Inform a user why they cannot see voice channels. - -`++wrapmini` - Instruct a user to wrap their code. - -`++listmacrosembed` - View the rest of the macros available. These are just the commonly used ones! ## HangoutBot **Description:** HangoutBot is a general usage bot, replacing some of the functionality of HotBot. +**Source:** https://github.com/the-programmers-hangout/HangoutBot + **Prefix:** `tph!` ### Commands @@ -74,31 +58,13 @@ This page details the bots you can interact with on our server. There are other `tph!userinfo` - Displays info for a user. -## Aura - -**Description:** Aura bot will hand out karma to users that earn it. Giving karma is as simple as mentioning (tagging) a user and thanking them in the same message. - -**Prefix:** `karma!` - -### Commands - -`karma!explain` - Details how the karma system works. - -`karma!help` - Displays help information. - -`karma!karma` - Displays your karma. - -`karma!leaderboard` - Displays the karma leaderboard. - -`karma!profile` - Gives a karma breakdown per channel. - -`karma!reactions` - Details the reactions that Aura can add to messages. - ## Keeper **Description:** Keeper is a bot that allows you to bookmark messages by adding the `:bookmark:` emote reaction to a message. +**Source:** https://github.com/ddivad195/keeper + **Prefix:** `keeper!` ### Commands @@ -106,10 +72,23 @@ This page details the bots you can interact with on our server. There are other N/A + +## ModMail + +**Description:** This bot lets you privately contact the staff team. DM it to start a discussion! + +**Source:** https://github.com/JakeJMattson/ModMail + +**Usage:** All you need to do is send a message. We'll see any edits you make to your message too! + + + ## Mimic **Description:** Mimic is a bot that talks like you! If you opt-in it will save your messages and build markov chains in order to generate sentences that mimic how you and other users type! +**Source:** https://github.com/itsHobbes/mimic + **Prefix:** `mimic!` ### Commands @@ -136,10 +115,60 @@ N/A `mimic!stats` - Display statistics of your messages + + +## Polly + +**Description:** Polly is our macro bot. + +**Source:** https://github.com/the-programmers-hangout/Polly + +**Prefix:** `++` or `+` for a self destructing invocation + +### Commands + +#### Help + +`++listmacros` - Lists all of the available macros + +#### Here are some commonly used macros + +`++ask` - If a user is looking for DMs, waiting for "experts", or anything else to delay asking their question use this. + +`++beginners` - Redirect a user to the beginners channel. Their question has probably been answered there. + +`++bin` - Hastebin links for long code snippets. + +`++bots` - Displays a link to this page. + +`++cc` - Redirect a user to our sister server Controversy Central. + +`++faq` - Displays a link to the FAQ page. + +`++hire` - Redirect a user to #projectlistings or #open-source-contributions. + +`++how2ask` - If a user isn't providing enough detail use this. + +`++imageofcode` - Images of code can be really hard to read, let people know they should post the code as text instead. + +`++noresearch` - Research is an important part of programming. Encourage people to research *then* ask! Ask them what they found if anything. + +`++patience` - Remind users not to pester others in channels. + +`++techchoice` - If a user is asking between X and Y tech in a general case, use this. + +`++voice` - Inform a user why they cannot see voice channels. + +`++wrapmini` - Instruct a user to wrap their code. + + + ## ReWizard **Description:** ReWizard is a utility bot for regex. It can find, replace, split, and test regular expressions. +**Source:** https://github.com/jkbbwr/rewizard + **Prefix:** `re!` ### Commands @@ -157,12 +186,71 @@ N/A `re!valid` - Tests whether the given regex is valid. + ## StandupBot **Description:** StandupBot is a bot that controls the standup channel. It enforces a strict message format. Once you have successfully sent a message you will no longer be able to post in the standup channel for 20 hours. +**Source:** https://github.com/the-programmers-hangout/standup + **Prefix:** N/A ### Commands N/A + + + +# Passive bots + +These are bots you will see in the server but you will not need to interact with them. They automatically do their job! + +## EmbedBot + +**Description:** EmbedBot allows staff to manage and post embed messages into various channels. + +**Source:** https://github.com/JakeJMattson/EmbedBot + + +## Emourge + +**Description:** Emourge tracks emote usage. We use this to help us identify the least used emotes incase we want to add some new ones! + +**Source:** https://github.com/dfireBird/emourge + + +## Hawk + +**Description:** Hawk manages nickname prefixes & suffixes. It adds 🔨 to staff nicks and organises the occasional nick party! + +**Source:** https://github.com/the-programmers-hangout/Hawk + + + +## Nano + +**Description:** Nano manages our AMAs. Whenever someone is accepted for an AMA, we'll give them a run down of how it works. + +**Source:** https://github.com/the-programmers-hangout/Nano + + +## Skadi + +**Description:** Skadi manages activity roles on the server. + +**Source:** This source isn't publically available. We don't want people trying to game the system. + + +## Taboo + +**Description:** Taboo makes sure only accepted file formats are uploaded. + +**Source:** https://github.com/the-programmers-hangout/Taboo + + + +## Watchdog + +**Description:** Watchdog guards the gates of our server against raids and bots. + +**Source:** This source isn't publically available.