Skip to main content

Commands

This page explains how to use Ririko's commands and how to control them in your server. It ends with a list of every command. Each feature page has the full options of its commands.

1. Use a Command​

Ririko has two kinds of commands. Both do the same thing.

  • Slash commands. Type / in the message box, pick a command, and fill in its options.
  • Prefix commands. Type a prefix, then the command name and its options. The default prefix is !. For example, !balance or !play never gonna give you up.

You can also mention the bot instead of using a prefix, for example @Ririko help.

Some commands have short names called aliases. !bal works like !balance. The tables in section 7 show the aliases.

A few commands are context menus. You right-click a message and choose Apps. See section 6.

1.1. Get Help​

Run /help (or !help) to open the Help Center.

  1. Run /help.
  2. Pick a category in the menu.
  3. Read the commands in that category.

The Ririko Help Center: an embed that lists every command category with its number of commands, and a menu to pick a category.

To see one command, run /help command:<name>. Ririko shows its description, usage, aliases, permissions and cooldown.

1.2. Change the Prefix​

Only members with the Manage Server permission can change the prefix. A prefix has 1 to 5 characters and no spaces.

  1. Run /prefix. Ririko shows the current prefix.
  2. Run /prefix set:? to set the prefix to ?.

You can also change the prefix on the dashboard General page. Slash commands do not use the prefix.

2. Who Can Use a Command​

Most commands are open to everyone. Some commands need a Discord permission. The tables in section 7 list them.

  • The command checks the permission of the person who runs it.
  • Ririko also needs the matching permission. If it lacks one, it tells you which.
  • Moderation commands also check the role order. You cannot act on a member whose highest role is equal to or above yours.
  • The server owner passes every permission check.
  • Commands marked "server only" do not work in direct messages.
  • Bot owners are the people listed in BOT_OWNER_ID. They can use owner-only actions, such as the global rules in /tcg-admin.

3. Cooldowns and Limits​

Each command has a cooldown. After you use a command, you must wait before you use it again. The cooldown counts per member. The /help command shows the cooldown of a command.

Ririko also limits how fast you can send commands. The default is 10 commands in 10 seconds. Server owners and members with the Administrator permission pass this limit.

A server admin can change the cooldown of a command. See section 4.

4. Control Commands in Your Server​

You need the Manage Server permission.

  1. Open the dashboard and pick your server. See dashboard.md.
  2. Open the Commands page.
  3. Find the command. Use the search box.
  4. Change the rule. You can:
    • turn the command off,
    • allow only some roles,
    • block some roles,
    • set a different cooldown.
  5. Add a channel rule if the command should behave differently in one channel.
  6. Save.

Rules apply to slash and prefix commands.

  • A channel rule wins over the server rule.
  • Threads follow the rules of their channel.
  • Members with Manage Server ignore on/off and role rules, so they cannot lock themselves out. Cooldowns still apply to them.
  • /help, /ping and /prefix are always available.

The Games page sets the same kind of rule for the mini-games. See modules.md.

4.1. Maintenance Mode​

An operator can put the bot in maintenance mode with ririko bot:maintenance. While it is on, only bot owners can run commands. Everyone else gets a message with the reason. See development.md.

5. Register Slash Commands​

Discord allows 100 slash commands in each scope. Ririko uses two scopes.

  • Global. Member commands. They show in every server. They also include the context menu.
  • Per server. Admin and setup commands. Ririko registers them in each server it joins. The next list shows which commands they are.

Per-server commands:

  • Moderation: automod, ban, unban, softban, kick, timeout, untimeout, warn, history, note, nick, purge, lock, unlock.
  • Server setup: prefix, welcomer, farewell, autorole, temprole, create-reaction-role, reaction-roles, autovoice, setup-music.
  • AI and images: aichannel, aipersona, setup-stablediffusion-api, stablediffusion-model.
  • Streams, events and cards: stream, setup-stream-notification, giveaway, tcg-admin.

The old short names are prefix-only. They do not use slash slots. Their slash form is the main command.

Prefix-only nameSlash form
!gcreate, !gend, !greroll, !gdelete, !gedit, !glist/giveaway action:<...>
!avc/autovoice
!vname, !vlimit, !vlock, !vunlock, !vpermit, !vkick, !vclaim, !vtransfer/voice action:<...>
!subscribe, !unsubscribe/stream action:<...>

If you host Ririko yourself, register the slash commands once:

  1. Run the bot with SYNC_COMMANDS=true once, or run this command:

    ririko commands:sync --global --all-guilds
  2. Wait. Discord can take a while to show global commands. Press Ctrl+R in Discord to refresh.

To see how many slots are free, run ririko commands:sync with no options. The full steps for Docker are in deployment.md. The command-line tool is in development.md.

6. Message Context Menu: Translate to English​

You can translate a message into English.

  1. Right-click the message. On a phone, open the message menu.
  2. Choose Apps, then Translate to English.

Only you see the result. It uses the AI provider of the server. See ai.md.

  • It translates the text of the message and the readable text of its embeds.
  • It does not read attachments or linked pages.
  • Input is limited to 12,000 characters.
  • A result longer than 2,000 characters comes as the file translation-en.txt.
  • The cooldown is 10 seconds.
  • This is a context menu only. There is no /translate command.
  • Translation sends the text to an AI provider, so you must have pressed I agree on the AI question first. Until then you see the question in place of the translation (ai.md section 2.1).

7. All Commands​

This list shows every command. "Everyone" means no permission is needed. An alias works with a prefix, such as !bal.

7.1. General​

CommandAliasesWhat it doesWho can use it
/pinglatencyShows the bot's latency.Everyone
/helpcommands, hOpens the Help Center.Everyone
/freegamesfree-games, freegameShows free games. See modules.md.Everyone to show. Manage Server to set up

7.2. Economy​

See economy.md.

CommandAliasesWhat it doesWho can use it
/balancebal, moneyShows a wallet and bank.Everyone
/dailydClaims the daily reward.Everyone
/depositdepMoves credits into the bank.Everyone
/withdrawwithMoves credits out of the bank.Everyone
/paygive, transferSends credits to a member.Everyone
/leaderboardlb, topShows the XP ranking.Everyone
/profilerankShows a profile card or sets its background.Everyone
/shopstoreLists the shop or buys an item.Everyone
/inventoryinv, bagLists your items.Everyone
/useconsumeUses an item.Everyone
/karmakShows karma or gives 1 karma.Everyone (server only to give)

7.3. Music​

See music.md. All music commands work in a server only.

CommandAliasesWhat it doesWho can use it
/playpPlays or queues a song.Everyone
/pausePauses.Everyone, or the DJ role
/resumeResumes.Everyone, or the DJ role
/skips, nextSkips the song.Everyone, or the DJ role
/backprev, previousPlays the previous song.Everyone, or the DJ role
/stopStops and clears the queue.Everyone, or the DJ role
/queueq, listShows the queue.Everyone
/nowplayingnpShows the current song.Everyone
/volumevol, vShows or sets the volume.Everyone, or the DJ role to set
/looprepeat, lSets the loop mode.Everyone, or the DJ role
/shuffleshShuffles the queue.Everyone, or the DJ role
/seekJumps to a time.Everyone, or the DJ role
/filterf, effectsTurns an audio filter on or off.Everyone, or the DJ role
/lyricslyShows lyrics.Everyone
/joinconnect, jJoins your voice channel.Everyone
/leavedc, disconnectLeaves the voice channel.Everyone, or the DJ role
/playlistplManages your playlists.Everyone
/setup-musicCreates the music channel.Manage Server

"Or the DJ role" means: when the server sets a DJ role, only that role and members with Manage Server can use the command.

7.4. AI and Images​

See ai.md.

CommandAliasesWhat it doesWho can use it
/aiaskChats, or changes the AI settings. With action:clear, scope:here clears your memory in this channel and scope:all (!ai clear all) deletes your AI conversations in every server and channel. Messages already sent to an AI provider cannot be recalled. With action:consent, consent:status shows whether and when you agreed to AI features, and consent:withdraw (!ai consent withdraw) takes your consent back and deletes your AI conversations and AI preferences. Chat, translation and images work only after you press I agree on the question Ririko shows you (ai.md section 2.1).Everyone. Manage Server for the settings
/chatcChats with Ririko.Everyone
/aiclearclearchat, reset-aiClears your chat memory.Everyone
/aichannelsetaichannelSets the AI channel.Manage Server or Manage Channels
/aipersonaaistyleSets the AI personality.Manage Server
/aimodelsetmodelShows or sets the AI model.Everyone to show. Manage Server to set
/imagineimg, ai-image, generate-imageMakes an image. You must have pressed I agree on the AI question first.Everyone
/stablediffusion-modelsdmodel, sd-model, imagemodel, image-modelSets the image defaults.Manage Server
/setup-stablediffusion-apisetup-sd-apiExplains where image keys go.Manage Server
Translate to EnglishContext menu.Everyone

7.5. Moderation​

See moderation.md. All moderation commands work in a server only.

CommandAliasesWhat it doesPermission
/warnwWarns a member.Timeout Members
/timeoutmute, toTimes a member out.Timeout Members
/untimeoutunmuteEnds a timeout.Timeout Members
/kickbootKicks a member.Kick Members
/softbansbBans and unbans, to delete messages.Ban Members
/banbBans a member.Ban Members
/unbanEnds a ban.Ban Members
/purgeclear, cleanDeletes messages.Manage Messages
/lockLocks a channel.Manage Channels
/unlockUnlocks a channel.Manage Channels
/nicknicknameChanges or resets a nickname.Manage Nicknames
/historymodlogs, casesShows a member's moderation history.Timeout Members
/noteAdds or shows staff notes.Timeout Members
/automodShows or changes AutoMod rules.Manage Server

7.6. Server Tools​

See modules.md.

CommandAliasesWhat it doesWho can use it
/streamManages stream alerts.Everyone to list. Manage Server for the rest
/subscribesub, stream-sub, streamsubFollows a streamer (prefix only).Manage Server
/unsubscribeunsub, stream-unsub, streamunsubUnfollows a streamer (prefix only).Manage Server
/setup-stream-notificationsetup-twitch, setup-stream, setup-streams, setup-stream-channel, setstreamchannel, stream-channelSets the alert channel.Manage Server
/stream-statustwitch-status, streamstatus, streams, streamersLists followed streamers.Everyone
/giveawayManages giveaways.Everyone to list. Manage Messages or Manage Server for the rest
/gcreate, /gend, /greroll, /gdelete, /gedit, /glistOld giveaway names (prefix only).Same as /giveaway
/autovoiceSets up "Join to Create" channels.Manage Channels or Manage Server
/voiceManages your temporary voice channel.The channel owner
/avc, /vname, /vlimit, /vlock, /vunlock, /vpermit, /vkick, /vclaim, /vtransferOld voice names (prefix only).Same as /autovoice and /voice
/create-reaction-rolecreatereactionrole, crrAdds a reaction role.Manage Roles or Manage Server
/reaction-rolesreactionroles, rrLists or removes reaction roles.Manage Roles or Manage Server
/autoroleauto-role, joinroleSets join and verification roles.Manage Roles or Manage Server
/temproletemporaryrole, troleGives roles that expire.Manage Roles or Manage Server
/reminderremindme, remindersSets reminders.Everyone
/prefixsetprefixShows or sets the prefix.Everyone to show. Manage Server to set
/timezonetz, settimezone, set-timezoneShows or sets a time zone.Everyone for yourself. Manage Server for the server
/get-avataravatar, pfpShows an avatar.Everyone
/guild-infoguildinfo, server-info, serverinfo, infoShows server information.Everyone (server only)
/member-infomemberinfo, user-info, userinfo, whoisShows member information.Everyone (server only)
/welcomerwelcomeSets the welcome card.Manage Server
/farewellgoodbyeSets the farewell card.Manage Server

7.7. Games​

See modules.md and adventure-game.md.

CommandAliasesWhat it doesWho can use it
/tictactoettt, tic-tac-toePlays Tic-Tac-Toe.Everyone
/rpsrock-paper-scissorsPlays Rock-Paper-Scissors.Everyone
/highlowhigh-low, hlPlays High or Low.Everyone
/coinflipcoin-flip, cfFlips a coin.Everyone
/dicerollRolls dice.Everyone
/adventureadv, journey, quest-adventurePlays a story adventure.Everyone (server only). Manage Server for the settings

7.8. Waifu TCG​

See waifu-tcg.md for admins and tcg-player-guide.md for players.

CommandAliasesWhat it doesWho can use it
/cardtcgManages your cards and gear.Everyone
/cardsalbum, mycardsOpens your card album.Everyone
/gamebattle, duel, tcggameDuels, expeditions, raids, quests and the town shop.Everyone
/itemtcgitem, itemsItems, enhancing and crafting.Everyone
/craftforgeCrafts gear and potions.Everyone
/loadoutgear, equipmentOpens the gear menu of a card.Everyone
/dungeontower, climb, spireClimbs the dungeon tower.Everyone
/tradecardtrade, tcgtradeTrades cards and credits.Everyone
/marketmarketplace, tcgmarketBuys and sells cards.Everyone
/waifuguildwguild, guildManages WaifuGuilds.Everyone
/achievementach, achievementsLists and claims achievements.Everyone
/tcg-admintcgadmin, tcgconfigSets card drops and the TCG rules.Manage Server, or the TCG Manager Role. Bot owners for global rules
/tcg-infotcginfo, tcgguide, tcg-guide, card-guide, waifu-guideOpens the TCG guide.Everyone

7.9. Anime, Reactions and Memes​

See modules.md.

CommandAliasesWhat it doesWho can use it
/animeSearches anime.Everyone
/mangaSearches manga.Everyone
/anime-charactercharacterSearches characters.Everyone
/waifuSends a random waifu image.Everyone
/wallpaperwallpapersFinds anime wallpapers.Everyone
/reactEach reaction name, such as hugSends a reaction GIF.Everyone
/memeEach template name, such as chadMakes a meme.Everyone