From bcb9c9919fa21e1f0b4c1fdbcc38f55f0551a3d8 Mon Sep 17 00:00:00 2001 From: Vivian <19847740+VivianTheFox@users.noreply.github.com> Date: Sun, 17 May 2026 19:42:27 -0500 Subject: [PATCH] Update command-reference.md Add the rest of the slash commands to the command reference, merging the entries previously General Current draft is missing additional details regarding the `/group` and `/userproxy` commands --- docs/docs/guide/command-reference.md | 151 ++++++++++++++++++++++----- 1 file changed, 127 insertions(+), 24 deletions(-) diff --git a/docs/docs/guide/command-reference.md b/docs/docs/guide/command-reference.md index 072b439..17dc4d5 100644 --- a/docs/docs/guide/command-reference.md +++ b/docs/docs/guide/command-reference.md @@ -1,45 +1,148 @@ # Command Reference -This page is NOT a comprehensive list of all commands available in /plu/ral. -This page is for extra information about commands that may not be clear from their descriptions. +## Slash Commands +Text-based commands that show up when a user types `/` -For a complete list of commands, simply type `/` in a discord channel with /plu/ral in it, and select /plu/ral's icon on the left. +### `/account` +These commands synchronize all data between the two accounts; the accounts are internally treated by /plu/ral as one account, with one exception: group shares are per discord account and will not be inherited by the other account. +- `/account share ` + - Request to share data with user account +- `/account accept ` + - Accept `/account share` from user account. + - Requires running `/delete_all_data` if user account data is present -## Message Commands -Message commands are commands accessed by right-clicking a message (or hold on mobile), and clicking the `Apps` option. +### `/api` +- Create and manage your /plu/ral integrations -### /plu/ral debug -This command is used to get the proxy logs for any message. -If used on a proxied message, it will return the logs for the original message. +### `/autoproxy` +Automatically proxy messages. +- `/autoproxy` + - Toggle autoproxy +- `/autoproxy enable:` + - Enable or disable autoproxy +- `/autoproxy ` + - Set to a specific member immediately +- `/autoproxy global:` + - Whether to proxy everywhere or just in this server; Default is False +- `/autoproxy expiry<1d2h3m4s|None>` + - Set expiry time (format: 1d2h3m4s); Default is None (never expires) +#### Autoproxy Modes +- `/autoproxy mode front` + - Using proxy tags will NOT switch the autoproxied member +- `/autoproxy mode latch` [Default Mode] + - Using proxy tags WILL switch the autoproxied member +- `/autoproxy mode locked` + - Autoproxy will not switch even if you use proxy tags +- `/autoproxy mode disabled` + - ALL proxying (including with tags) will be disabled -If you are not the original author of the message, or a member of the usergroup that proxied the message, some logs will be removed, such as group channel restrictions, and autoproxy information. This is to keep all potentially sensitive information private. +### `/config` +- Configure /plu/ral settings. -### /plu/ral edit -This command is used to edit /plu/ral messages, including both traditional webhook messages, and userproxy messages. +### `/delete_all_data` +- Delete all your /plu/ral account data -Running this command will respond with a pop-up, allowing you to make changes to the message. +### `/edit` +- Edit your most recent message -### /plu/ral proxy info -This command is used to tie a proxied message to the original sender. Use on any proxied message to get the original sender's information. +### `/export` +- Export your data -#### proxy info without /plu/ral -If you do not use /plu/ral and would like to see the original sender's information,
-you can add the [/plu/ral info bot](https://discord.com/oauth2/authorize?client_id=1358295664882094090) to your account. +### `/group` - WIP -This is a minimal bot with just the proxy info command, that can be used anywhere. +### `/help` +- Get started with the bot -You do **NOT** need to add this bot to your account if you are using /plu/ral, as it is already included in the bot. +### `/import` +- Import data from /plu/ral, PluralKit, or Tupperbox -This bot cannot be added to servers. +### `/member` +- `/member info ` + - Get information about your members +- `/member list` + - List all your members +- `/member new ` + - Create a new member +- `/member remove ` + - Remove a member +#### Editing Members +- `/member set avatar ` + - Set a member's avatar +- `/member set bio ` + - Set a member's bio +- `/member set birthday ` + - Set a member's birthday +- `/member set color ` + - Set a member's color +- `/member set custom_id ` + - Set a member's custom id field +- `/member set group ` + - Set a member's group +- `/member set name ` + - Set a member's name +- `/member set pronouns ` + - Set a member's pronouns +#### Member Proxy Tags +- `/member tags add prefix ` + - Proxy tag prefix (e.g. {prefix}text) +- `/member tags add suffix ` + - Proxy tag suffix (e.g. text{suffix}) +- `/member tags add regex ` + - Whether the proxy tag is matched with regex (default: False) +- `/member tags add case_sensitive ` + - Whether the proxy tag is case sensitive (default: False) +- `/member tags add avatar ` + - Avatar for the proxy tag (8MB max) +- `/member tags clear ` + - Clear all proxy tags from a member +- `/member tags avatar ` + - Sets a avatar for a proxy of a member +- `/member tags remove ` + - Remove a proxy tag from a member -## General -### /ping +### `/ping` - Interaction latency - Average latency to *receive* the last 100 interactions (interactions are commands, button presses, etc.) - Proxy latency - Average latency from a message being sent, to the proxy message being sent for the last 100 proxied messages - note: some messages messages will not be included in this average, for example if they include attachments, cloned emoji, dice rolls, etc. -### /switch -This command is nothing more than a shortcut to `/autoproxy`, with the global option set to `True`. \ No newline at end of file +### `/reproxy` +- Reproxy your latest message. Must be the latest message in the channel + +### `/say` +- Send a message as a member without a userproxy + +### `/stats` +- Get your /plu/ral stats + +### `/switch ` +- Shortcut for `/autoproxy global:True` +- Sets user to autoproxy to specified member and sets `/autoproxy Global` to True + +### `/userproxy` - WIP + +### `/version` +- Get bot version and list of recent changes + + +## Message Commands +Message commands are commands accessed by right-clicking a message (or hold on mobile), and clicking the `Apps` option. They cannot be entered as chat commands. + +### /plu/ral debug +- This command is used to get the proxy logs for any message. +- If used on a proxied message, it will return the logs for the original message. +- If you are not the original author of the message, or a member of the usergroup that proxied the message, some logs will be removed, such as group channel restrictions, and autoproxy information. This is to keep all potentially sensitive information private. + +### /plu/ral edit +- This command is used to edit /plu/ral messages, including both traditional webhook messages, and userproxy messages. +- Running this command will respond with a pop-up, allowing you to make changes to the message. + +### /plu/ral proxy info +- This command is used to tie a proxied message to the original sender. Use on any proxied message to get the original sender's information. +- #### proxy info without /plu/ral + - If you do not use /plu/ral and would like to see the original sender's information,
you can add the [/plu/ral info bot](https://discord.com/oauth2/authorize?client_id=1358295664882094090) to your account. + - This is a minimal bot with just the proxy info command, that can be used anywhere. + - You do **NOT** need to add this bot to your account if you are using /plu/ral, as it is already included in the bot. + - This bot cannot be added to servers.