FlaviBot documentation

How the bot actually works, written to be read in order. Every page is kept against the running code, so what you read here is what runs.

Start reading

Getting started

7 pages

Invite the bot, find the dashboard, set the basics.

  1. 01Adding FlaviBotWhere the invite link is, what it asks for, and what happens the moment the bot joins.
  2. 02What FlaviBot can seeWhich events reach the bot, which never do, and what a member can opt out of.
  3. 03Finding your dashboardHow to open it, who is allowed in, and how settings are saved.
  4. 04Commands and /helpThe two ways to run a command, what /help shows, and why a command sometimes refuses.
  5. 05Prefix, mentions and languageSet the text prefix, use the bot mention as a fallback, and pick the server's language.
  6. 06Turning things on and offEnable or disable a whole module, or a single command, and read the status dots.
  7. 07Setting up a custom botRun FlaviBot's features under your own bot account, with your name, avatar and status.

Autoresponder

11 pages

Build automations: triggers, filters, actions, variables.

  1. 01What an autoresponder isThe mental model behind every automation you build with FlaviBot.
  2. 02TriggersEvery event a rule can listen to, and what each one gives you.
  3. 03Filters and gatesEverything that can stop a rule between the event and the actions.
  4. 04ActionsThe building blocks a rule can run, and what each one hands back.
  5. 05VariablesWhere the values in your messages come from, and how to store your own.
  6. 06Conditions and timingRun a step only sometimes, and make things happen later.
  7. 07Groups and panelsSeveral buttons, one message, one place to edit them.
  8. 08BatchingReact to a burst instead of to each event.
  9. 09Custom eventsLet one rule call another, instead of copying steps around.
  10. 10PresetsInstall a ready-made automation, or share one of yours.
  11. 11Every action, in detailWhat each building block does, what it needs, and the values it hands to the steps after it.

Music

14 pages

Playback, playlists, DJ mode, the web player and 24/7.

  1. 01The Music moduleThe four places you can control music, and what unlocks what.
  2. 02Playing musicWhat you can hand to /play, where the audio comes from, and how to stop.
  3. 03Playback controlsPause, skip, seek, volume and loop, plus how vote skip decides.
  4. 04The queueRead it, reorder it, remove from it, and clean it up.
  5. 05Audio filtersThe nine effects you can put on the audio, and how to take them off.
  6. 06The now playing message and the controllerThe buttons FlaviBot posts, and the dedicated channel that replaces commands.
  7. 07Announcements and the announcement channelWhere FlaviBot posts about the music, and how to make it quieter.
  8. 08AutoplayKeep the music going when the queue runs out, and steer what it picks.
  9. 09The web playerDrive the music from a browser instead of typing commands.
  10. 10PlaylistsSave what you play, replay it anywhere, and let FlaviBot build one for you.
  11. 11DJ modeDecide exactly who may play, skip, stop or touch the volume.
  12. 12Restricting the bot to certain voice channelsKeep the music out of channels where it does not belong.
  13. 1324/7 modeKeep FlaviBot permanently in one voice channel, and decide what it plays there.
  14. 14SpotifyPlay Spotify links, and link your account to reach your own playlists.

Moderation

6 pages

Sanctions, the case history, automod and server logs.

  1. 01How moderation worksWhat FlaviBot records every time you sanction someone, and who is allowed to do it.
  2. 02The sanctionsNote, warn, timeout, kick, ban, tempban and softban, plus the two commands that undo them.
  3. 03Mod-log, DMs and auto-escalationWhere moderation events are posted, what the sanctioned member is told, and how warns turn into automatic sanctions.
  4. 04Cases and historyLook up a case, read a member's record, correct a reason, and cancel a sanction without erasing it.
  5. 05Discord AutoModManage Discord's own filters from the dashboard, and make a rule hand out real FlaviBot warns.
  6. 06Server logsA written record of what happens on your server, event by event, in the channels you choose.

Levels and economy

8 pages

XP, rank cards, role rewards, coins and the shop.

  1. 01Levels and economy[object Object]
  2. 02How XP is earnedMessage XP, voice XP, the cooldown, multipliers, and every setting that decides who earns where.
  3. 03Levels and role rewardsThe level curve, the maximum level, and how roles are handed out as members climb.
  4. 04Level-up announcementsWhere the level-up message is posted, what you can write in it, and the separate message for voice.
  5. 05The rank card and the leaderboardWhat /rank shows, how far you can redesign the card, and how the public ranking works.
  6. 06Currency and balancesNaming your currency, what a wallet is, and the admin tools for correcting one.
  7. 07Earning coinsThe eight earning rules, what each one pays for, and the caps that keep a currency from inflating.
  8. 08The shop, items and tradingBuilding a shop worth saving for, and the three ways coins and items move between members.

Engagement

7 pages

Welcome messages, starboard, giveaways, suggestions, birthdays.

  1. 01What the Engagement module coversThe six features that make a server feel alive, and the settings they all share.
  2. 02Welcome and goodbye messagesGreet new members, hand them a role, say goodbye when they leave, and design the card that goes with it.
  3. 03StarboardLet your members pin the best messages themselves, by reacting to them.
  4. 04SuggestionsCollect ideas from your members in one channel, with voting and an approved / rejected status on each one.
  5. 05GiveawaysRun prize draws with entry requirements, automatic winner picking and rerolls.
  6. 06BirthdaysAnnounce a member's birthday in a channel of your choice, with an optional role for the day.
  7. 07Feed announcementsPost new YouTube videos, Twitch and Kick go-lives, and Reddit posts into your Discord channels.

Tickets

6 pages

Panels, categories, transcripts and the dashboard inbox.

  1. 01How tickets workThe panel, the ticket channel, and everything the bot does between them.
  2. 02Setting up a panelThe one page where you decide where tickets appear, who answers them and what members see.
  3. 03When someone opens a ticketThe checks the bot runs, the channel it builds, and the two ways staff can open one for a member.
  4. 04Handling a ticketClaiming, escalating, pulling people in, private notes, and letting the assistant answer first.
  5. 05Closing, reopening and transcriptsWhat closing actually does, who is allowed to do it, and where the conversation ends up.
  6. 06The dashboard sideAnswer tickets from the browser, read the timeline, and give your support team access without giving away the server.

Temporary voice

4 pages

Self-serve voice rooms and the control panel.

  1. 01Temporary voice channelsMembers make their own voice room by joining one channel, and the room disappears once it empties.
  2. 02Creator channelsThe channel members join to get a room, and everything you decide about the rooms it hands out.
  3. 03The control panelThe buttons FlaviBot posts in every room, and exactly what each one does.
  4. 04Ownership and claimingWho is in charge of a room, how ownership is handed over, and how an abandoned room is taken over.

Premium

6 pages

What each tier adds, and how to activate it.

  1. 01What Premium isThe three levels FlaviBot gates things behind, and what paying actually changes.
  2. 02User premium and server premiumA subscription belongs to your account; premium on a server is a slot you spend from it.
  3. 03Silver, Gold and PlatinumThe three plans on sale, and what each one adds over the one below it.
  4. 04Activating premium on a serverBuying a plan does not upgrade anything by itself; this is the step that does.
  5. 05Changing and cancellingMove a server, switch plan, deal with a failed payment, stop paying.
  6. 06Limits by tierEvery number, per plan, in one place.

69 pages so far. More sections land as features get written up; the sidebar always lists everything that exists.