cat3890

[cat3890]

Getting Started Guide

Updated February 2021

Cat has limited server slots and is not invitable outside of special circumstances. Use c!botfriends in a server you share with cat to see other bots that you can use that have the same functionalities as cat does.

If you're the type to want to explore by yourself, feel free to use c!help in a server with cat and start using commands that you can see.

cat commands

cat's default prefix is c!

You can set a different prefix for your server with c!set serverprefix

A long list of every command is available with c!help

More detailed help is available for single commands, for example: c!help choose

Topic-based cat command breakdown

Audio

c!help Audio • Audio player with custom playlist system

Mod/Admin

c!help Admin • Role commands

c!help Alias • Set up shortcuts for commands

c!imgwelcome • Custom server welcome images

c!lvladmin • Leveler administration tools, autorole via xp, etc

c!help Raffle • Set up raffles/giveaways

c!help roletools • Reaction role setup

c!help RSS • RSS feeds for your server

c!sendembed • Send an embed as the bot

c!help Starboard • Starboard management

c!translateset • Configure auto-translating with flag emoji reactions

c!msgvote • Thumbs up/down on every message with auto-deletion threshold

c!rpoll • Set up a reaction-based poll

Bot Automoderation

c!check • Nickname checker & changer for hoisters, bad names

c!nolinks • Very heavy-handed link killer, can whitelist roles

c!antimentionspam • Take actions on encountering spam

c!help Filter • Filter settings

Games

c!help Adventure • Text-based adventure game

c!help AdventureAlert • Alerts for adventure

c!help Casino • Casino games

@cat hello • Cleverbot

c!help Economy • Slot machine

c!help PlantTycoon • Grow and tend to plants

c!help Race • Animal racing (mods, run c!setrace mode for more fun)

c!help RussianRoulette • Russian roulette

c!trivia • Trivia games

c!help Unbelievaboat • Unbelievaboat economy commands

Image-Based Commands/Memes

c!help NotSoBot • Many image based commands from NotSoBot

c!bigmoji • Posts a large image of an emoji

c!retrosign • Make an 80s retro image

c!help meme • ImgFlip meme generation from over 100 templates

c!inspirobot • "Inspiring" random messages

c!help Randimals • Random animal images

NSFW Commands

only available in NSFW-flagged channels

c!help Nsfw • NSFW image commands

c!help Image • Imgur, Imgur subreddit and Giphy commands

c!urban • Urban Dictionary

Users

c!help Away • Bot responds for the user during specific statuses

c!bday • Birthday settings

c!highlight • Be notified of specific words

c!remindme • Be reminded of things

c!time • Timezone-related user settings

User Activity

c!help chatchart • Shows a pie chart of channel activity

c!help Leveler • Chat based xp with profile and rank cards, top command

Random

c!catfact • Cat facts

c!compliment • Compliments

c!dragon • Look up a dragon on flightrising.com

c!help General • Stopwatch, coinflip, choose, roll, rps

c!jisho • Look up Japanese words via Kana/Kanji/romanji

c!insult • Insult someone

c!tarot • Tarot readings

c!tweets • Twitter lookup

c!pokedex • Pokemon info

c!weather • Look up weather as city,state

c!whoplays • Who's playing that game?

c!wolfram • Wolfram Alpha lookup

cat FAQ

~~~~~ Admin/Mod Section ~~~~~

Q: I want cat to be able to be used by my mods and admins for mod actions.

A: Use c!set adminrole and c!set modrole to set the appropriate roles on your server. (Guild owner only)

Read c!help Mod, c!help ModLog (once mod action logs are turned on), and c!help set (commands are case sensitive) to see what mod actions and settings are available.

Q: I want to set up a channel to log mod actions.

A: Use c!modlogset to see the overall settings, and c!modlogset modlog to set a channel with default reporting for mod actions, like kick and ban. More mod log reports like voice mutes, bans via the filter, and channel mutes can be enabled under c!modlogset cases. If nothing happens when an action should be reported, make sure your bot can read and write to the channel and also make sure to enable the embed messages permission.

Q: I want cat to tell me about everything that happens on the server with message edits, deletions, users joining, leaving, gaining or losing roles, etc.

A: Use c!modlogset modlog #channel to set up a mod-log channel first. Use c!modlog to see the current state of the settings and what can be tracked and/or toggled. c!modlogset also has mod-log related settings for cases that should appear in the mod-log.

Q: I don't want my users to run a certain command or group of commands, or I want to have a role that can use a command.

A: Read c!help permissions to get started. There is a short guide at c!permissions explain and each subcommand to restrict or enable commands has detailed help. The audio module also has a DJ role setting to restrict audio use to a role. Use c!help Audio to see all of the audio commands, or c!audioset to look at the settings.

~~ Guild Customization Section ~~

Q: The bot should welcome people to the server in chat or DM and say something when people leave.

A: (Admin or Manage Guild permissions to use)

Text welcome and/or leave messages, with random choices: use c!welcomeset to get started

Image welcome, with a custom 500px x 150px background: use c!imgwelcome to get started (Guild owner only), and c!imgwelcome preview to see your edits.

Q: I want a role to be applied to people and/or bots when they join the guild.

A: (User must have Manage Roles and Manage Guild permisson to use) If the bot has permission to manage roles, c!autorole will have subcommands available to set roles for user joins. If you want to apply a role to bots when they join, use c!welcomeset bot role to set the role.

Q: I want roles awarded at certain levels of chat participation.

A: Read and explore c!role (Guild admin privledges needed to use).

Q: I want to customize the casino games.

A: (Guild owner to use)

Set the Casino name with c!casino name

Set admin settings for Casino with c!casino admin

Q: I want to be able to translate messages from other people.

A: Use c!translatereact to set up your guild for translations. After this toggle is turned on, anyone can react to a message with a country flag emoji and the message will be translated.

If you have any questions please submit them through the bot by using c!contact with your message. You can attach a file like an image to this message in case you want to submit a screenshot. Trolls or abuse of this command will lead to being globally blacklisted from using the bot.

cat credit

cat is based on Red-DiscordBot's v3 rewrite for the rewrite branch of discord.py. Some things are custom, some things have been written by the community, and some things have been written by myself. I'm running cat for free for anyone's use so that I can find issues with the core code or common cogs and fix them. Anyone can run a copy of the code on their own, but you'll need to find your own hosting for it to run the bot 24/7, which costs money.

Cat's non-custom cogs include cogs from the following repos, some have been modified:

adorabilis: https://github.com/adorabilis/Adora-Cogs

adventure: https://github.com/aikaterna/gobcog/

aikaterna: https://github.com/aikaterna/aikaterna-cogs/

axas: https://github.com/Aioxas/ax-cogs

crossedfall: https://github.com/crossedfall/crossed-cogs/

fixator: https://github.com/fixator10/Fixator10-Cogs

flame: https://github.com/Flame442/FlameCogs

flap: https://github.com/flapjax/FlapJack-Cogs/

flare: https://github.com/flaree/Flare-Cogs

haru: https://github.com/HarukiGrande/GrandeCogs-V3

imgwelcome: https://github.com/aikaterna/imgwelcome

leveler: https://github.com/aikaterna/Fixator10-Cogs

palm: https://github.com/palmtree5/palmtree5-cogs

preda: https://github.com/PredaaA/predacogs

rjm: https://github.com/Redjumpman/Jumper-Plugins/

tmerc: https://github.com/tmercswims/tmerc-cogs/

toby: https://github.com/Tobotimus/Tobo-Cogs

trusty: https://github.com/TrustyJAID/Trusty-cogs

twentysix26: https://github.com/Twentysix26/x26-Cogs

will: https://github.com/tekulvw/Squid-Plugins

wyn: https://github.com/Wyn10/Wyn-RedV3Cogs

yuki: https://github.com/skeith/MayuYukirin/

zelarp: https://github.com/ZeLarpMaster/ZeCogsV3

If you're interested in running Red on your own, see the docs at: https://docs.discord.red/en/stable/