From 65841a574957c4a47edce99280059f293a3f05d1 Mon Sep 17 00:00:00 2001 From: Toby Larone <10854475+Toby-Larone@users.noreply.github.com> Date: Sat, 17 Oct 2020 16:33:33 +0100 Subject: [PATCH 1/2] feat: Add page to detail tph bots --- src/content/site/bots.md | 168 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 src/content/site/bots.md diff --git a/src/content/site/bots.md b/src/content/site/bots.md new file mode 100644 index 0000000..2e2f482 --- /dev/null +++ b/src/content/site/bots.md @@ -0,0 +1,168 @@ +--- +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. + +**Prefix:** `++` or `+` for a self destructing invocation + +### Commands + +#### Infractions/strikes + +`++selfhistory` - Send this in a Direct Message to HotBot to view your infraction/strike history + +#### Redirection & Rule reminders + +`++ask` - If a user is looking for DMs, waiting for "experts", or anything else to delay asking their question use this. + +`++beginner` - A more verbose version of `+beginners`. + +`++beginners` - Redirect a user to the beginners channel. Their question has probably been answered there. + +`++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. + +**Prefix:** `tph!` + +### Commands + +`tph!avatar` - View the avatar of a user. + +`tph!help` - Displays help information for the bot or a command. + +`tph!invite` - View the server invite link. + +`tph!listreminders` - List your reminders. + +`tph!productivemute` - Mutes all non-productive channels. (e.g hangout) + +`tph!remindme` - Sets a reminder. + +`tph!selfmute` - Mutes all channels. + +`tph!serverinfo` - Displays server information. + +`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. + +**Prefix:** `keeperhelp` + +### Commands + +N/A + + +## 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! + +**Prefix:** `mimic!` + +### Commands + +`mimic!about` - Displays bot information and source link. + +`mimic!all` - Generate a random number of sentences from all opted in user messages! + +`mimic!allstats` - Display statistics for all users + +`mimic!channels` - Lists all channels registered + +`mimic!help` - show all commands or detailed help of one command + +`mimic!opt-in` - Opt-in for your messages to be read. + +`mimic!opt-out` - Opt-out for all messages to be removed. + +`mimic!rand` - Generate a random number of sentences from random user's messages! + +`mimic!self` - Generate a random number of sentences from your own messages! + +`mimic!start` - Provide the start of a sentence and let mimic finish it! Use quotations around your sentence! + +`mimic!stats` - Display statistics of your messages + +## ReWizard + +**Description:** ReWizard is a utility bot for regex. It can find, replace, split, and test regular expressions. + +**Prefix:** `re!` + +### Commands + +`re!find` - Finds the first match of the given regex in the target. + +`re!find_all` - Finds all matches of the given regex in the target. + +`re!help` - Displays help information for the bot and the commands. + +`re!replace` - Replaces all matches of the given regex in the target with a replacement. + +`re!split` - Splits the target by the given regex. + +`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. + +**Prefix:** N/A + +### Commands + +N/A \ No newline at end of file From f53c469980c1f3b94458a48f60bcfc93f1250a5d Mon Sep 17 00:00:00 2001 From: Toby Larone <10854475+Toby-Larone@users.noreply.github.com> Date: Sat, 17 Oct 2020 16:38:30 +0100 Subject: [PATCH 2/2] feat: Add bots page to website menus --- src/components/Home/index.tsx | 1 + src/components/Sidebar/index.tsx | 1 + src/pages/bots.tsx | 42 ++++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+) create mode 100644 src/pages/bots.tsx diff --git a/src/components/Home/index.tsx b/src/components/Home/index.tsx index b28b90d..0d4d819 100644 --- a/src/components/Home/index.tsx +++ b/src/components/Home/index.tsx @@ -75,6 +75,7 @@ export const Home: FC = () => { about rules faq + bots resources tech spotlights diff --git a/src/components/Sidebar/index.tsx b/src/components/Sidebar/index.tsx index a06425b..557b4e8 100644 --- a/src/components/Sidebar/index.tsx +++ b/src/components/Sidebar/index.tsx @@ -41,6 +41,7 @@ export const Sidebar: FC> = (props) => { about rules faq + bots resources tech spotlights diff --git a/src/pages/bots.tsx b/src/pages/bots.tsx new file mode 100644 index 0000000..a90b7fa --- /dev/null +++ b/src/pages/bots.tsx @@ -0,0 +1,42 @@ +import { graphql } from "gatsby" +import React, { Fragment } from "react" +import cx from "classnames" +import { Mdx } from "../../generated/graphql" +import { ComponentQuery } from "../../typings" +import { Markdown } from "../components/Markdown" +import { SEO } from "../components/SEO" +import { PageContent } from "../components/PageContent" +import { HeaderBarebone } from "../components/HeaderBarebone" +import { buildToc } from "../utils" + +function BotPage({ data }: ComponentQuery<{ md: Mdx }>) { + const { md } = data + + const toc = buildToc(md.headings!) + + return ( + + + + + } toc={toc} /> + + ) +} + +export const query = graphql` + query BotPage { + md: mdx(frontmatter: { path: { eq: "/bots" } }) { + body + headings { + depth + value + } + } + } +` + +export default BotPage