Update command list documentation
This commit is contained in:
Ske
parent
373423e6c5
commit
628ae6beb7
@ -14,7 +14,7 @@ namespace PluralKit.Bot
|
||||
public static Command SystemRename = new Command("system name", "system rename [name]", "Renames your system");
|
||||
public static Command SystemDesc = new Command("system description", "system description [description]", "Changes your system's description");
|
||||
public static Command SystemTag = new Command("system tag", "system tag [tag]", "Changes your system's tag");
|
||||
public static Command SystemAvatar = new Command("system avatar", "system avatar [url|@mention|clear]", "Changes your system's avatar");
|
||||
public static Command SystemAvatar = new Command("system avatar", "system avatar [url|@mention]", "Changes your system's avatar");
|
||||
public static Command SystemDelete = new Command("system delete", "system delete", "Deletes your system");
|
||||
public static Command SystemTimezone = new Command("system timezone", "system timezone [timezone]", "Changes your system's time zone");
|
||||
public static Command SystemProxy = new Command("system proxy", "system proxy [on|off]", "Enables or disables message proxying in a specific server");
|
||||
@ -34,12 +34,12 @@ namespace PluralKit.Bot
|
||||
public static Command MemberBirthday = new Command("member birthday", "member <member> birthday [birthday]", "Changes a member's birthday");
|
||||
public static Command MemberProxy = new Command("member proxy", "member <member> proxy [add|remove] [example proxy]", "Changes, adds, or removes a member's proxy tags");
|
||||
public static Command MemberDelete = new Command("member delete", "member <member> delete", "Deletes a member");
|
||||
public static Command MemberAvatar = new Command("member avatar", "member <member> avatar [url|@mention|clear]", "Changes a member's avatar");
|
||||
public static Command MemberServerAvatar = new Command("member serveravatar", "member <member> serveravatar [url|@mention|clear]", "Changes a member's avatar in the current server");
|
||||
public static Command MemberAvatar = new Command("member avatar", "member <member> avatar [url|@mention]", "Changes a member's avatar");
|
||||
public static Command MemberServerAvatar = new Command("member serveravatar", "member <member> serveravatar [url|@mention]", "Changes a member's avatar in the current server");
|
||||
public static Command MemberDisplayName = new Command("member displayname", "member <member> displayname [display name]", "Changes a member's display name");
|
||||
public static Command MemberServerName = new Command("member servername", "member <member> servername [server name]", "Changes a member's display name in the current server");
|
||||
public static Command MemberKeepProxy = new Command("member keepproxy", "member <member> keepproxy [on|off]", "Sets whether to include a member's proxy tags when proxying");
|
||||
public static Command MemberRandom = new Command("random", "random", "Gets a random member from your system");
|
||||
public static Command MemberRandom = new Command("random", "random", "Looks up a random member from your system");
|
||||
public static Command MemberPrivacy = new Command("member privacy", "member <member> privacy [on|off]", "Sets whether a member is private or public");
|
||||
public static Command Switch = new Command("switch", "switch <member> [member 2] [member 3...]", "Registers a switch");
|
||||
public static Command SwitchOut = new Command("switch out", "switch out", "Registers a switch with no members");
|
||||
@ -64,12 +64,13 @@ namespace PluralKit.Bot
|
||||
|
||||
public static Command[] SystemCommands = {
|
||||
SystemInfo, SystemNew, SystemRename, SystemTag, SystemDesc, SystemAvatar, SystemDelete, SystemTimezone,
|
||||
SystemList, SystemFronter, SystemFrontHistory, SystemFrontPercent, SystemPrivacy
|
||||
SystemList, SystemFronter, SystemFrontHistory, SystemFrontPercent, SystemPrivacy, SystemProxy
|
||||
};
|
||||
|
||||
public static Command[] MemberCommands = {
|
||||
MemberInfo, MemberNew, MemberRename, MemberDisplayName, MemberServerName, MemberDesc, MemberPronouns,
|
||||
MemberColor, MemberBirthday, MemberProxy, MemberKeepProxy, MemberDelete, MemberAvatar,
|
||||
MemberColor, MemberBirthday, MemberProxy, MemberKeepProxy, MemberDelete, MemberAvatar, MemberServerAvatar,
|
||||
MemberRandom
|
||||
};
|
||||
|
||||
public static Command[] SwitchCommands = {Switch, SwitchOut, SwitchMove, SwitchDelete};
|
||||
|
||||
@ -7,10 +7,11 @@ nav_order: 3
|
||||
---
|
||||
|
||||
# How to read this
|
||||
Words in \<angle brackets> are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters. Note that **you should not include the brackets in the actual command**.
|
||||
Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank. Square brackets mean this is optional. Don't include the actual brackets.
|
||||
|
||||
# Commands
|
||||
## System commands
|
||||
*Optionally replace `[system]` with a @mention, Discord account ID, or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
|
||||
- `pk;system [id]` - Shows information about a system.
|
||||
- `pk;system new [name]` - Creates a new system registered to your account.
|
||||
- `pk;system rename [new name]` - Changes the name of your system.
|
||||
@ -20,23 +21,25 @@ Words in \<angle brackets> are *required parameters*. Words in [square brackets]
|
||||
- `pk;system timezone [location]` - Changes the time zone of your system.
|
||||
- `pk;system proxy [on|off]` - Toggles message proxying for a specific server.
|
||||
- `pk;system delete` - Deletes your system.
|
||||
- `pk;system [id] fronter` - Shows the current fronter of a system.
|
||||
- `pk;system [id] fronthistory` - Shows the last 10 fronters of a system.
|
||||
- `pk;system [id] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame.
|
||||
- `pk;system [id] list` - Shows a paginated list of a system's members.
|
||||
- `pk;system [id] list full` - Shows a paginated list of a system's members, with increased detail.
|
||||
- `pk;system [system] fronter` - Shows the current fronter of a system.
|
||||
- `pk;system [system] fronthistory` - Shows the last 10 fronters of a system.
|
||||
- `pk;system [system] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame.
|
||||
- `pk;system [system] list` - Shows a paginated list of a system's members.
|
||||
- `pk;system [system] list full` - Shows a paginated list of a system's members, with increased detail.
|
||||
- `pk;autoproxy [off|front|latch|member]` - Updates the system's autoproxy settings for a given server.
|
||||
- `pk;link <account>` - Links this system to a different account.
|
||||
- `pk;unlink [account]` - Unlinks an account from this system.
|
||||
|
||||
## Member commands
|
||||
*Replace `<name>` with a member's name or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
|
||||
- `pk;member <name>` - Shows information about a member.
|
||||
- `pk;member new <name>` - Creates a new system member.
|
||||
- `pk;member <name> rename <new name>` - Changes the name of a member.
|
||||
- `pk;member <name> displayname <new display name>` - Changes the display name of a member.
|
||||
- `pk;member <name> servername <new server name>` - Changes the display name of a member, only in the current serve.
|
||||
- `pk;member <name> servername <new server name>` - Changes the display name of a member, only in the current server.
|
||||
- `pk;member <name> description [description]` - Changes the description of a member.
|
||||
- `pk;member <name> avatar <avatar url|@mention|clear>` - Changes the avatar of a member.
|
||||
- `pk;member <name> serveravatar <avatar url|@mention|clear>` - Changes the avatar of a member in a specific server.
|
||||
- `pk;member <name> avatar <avatar url|@mention>` - Changes the avatar of a member.
|
||||
- `pk;member <name> serveravatar <avatar url|@mention>` - Changes the avatar of a member in a specific server.
|
||||
- `pk;member <name> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
|
||||
- `pk;member <name> proxy add [tags]` - Adds a proxy tag pair to a member.
|
||||
- `pk;member <name> proxy remove [tags]` - Removes a proxy tag from a member.
|
||||
@ -46,23 +49,39 @@ Words in \<angle brackets> are *required parameters*. Words in [square brackets]
|
||||
- `pk;member <name> birthdate [birthdate]` - Changes the birthday of a member.
|
||||
- `pk;member <name> delete` - Deletes a member.
|
||||
- `pk;random` - Shows the member card of a randomly selected member in your system.
|
||||
|
||||
## Switching commands
|
||||
- `pk;switch [member...]` - Registers a switch with the given members.
|
||||
- `pk;switch move <time>` - Moves the latest switch backwards in time.
|
||||
- `pk;switch delete` - Deletes the latest switch.
|
||||
- `pk;switch delete all` - Deletes every logged switch.
|
||||
- `pk;switch out` - Registers a 'switch-out' - a switch with no associated members.
|
||||
|
||||
## Server owner commands
|
||||
*(all commands here require Manage Server permission)*
|
||||
- `pk;log channel <channel>` - Sets the given channel to log all proxied messages.
|
||||
- `pk;log disable <#channel> [#channel...]` - Disables logging messages posted in the given channel(s) (useful for staff channels and such).
|
||||
- `pk;log enable <#channel> [#channel...]` - Re-enables logging messages posted in the given channel(s).
|
||||
- `pk;logclean <on/off>` - Enables or disables [log cleanup](/guide#log-cleanup).
|
||||
- `pk;blacklist add <#channel> [#channel...]` - Adds the given channel(s) to the proxy blacklist (proxying will be disabled here)
|
||||
- `pk;blacklist remove <#channel> [#channel...]` - Removes the given channel(s) from the proxy blacklist.
|
||||
|
||||
## Utility
|
||||
- `pk;log <channel>` - Sets the channel to log all proxied messages.
|
||||
- `pk;message <message id>` - Looks up information about a proxied message by its message ID.
|
||||
- `pk;message <message id / message link>` - Looks up information about a proxied message by its message ID or link.
|
||||
- `pk;invite` - Sends the bot invite link for PluralKit.
|
||||
- `pk;import` - Imports a data file from PluralKit or Tupperbox.
|
||||
- `pk;export` - Exports a data file containing your system information.
|
||||
- `pk;permcheck [server id]` - [Checks the given server's permission setup](/tips#permission-checker-command) to check if it's compatible with PluralKit.
|
||||
|
||||
## API
|
||||
*(for using the [PluralKit API](/api), useful for developers)*
|
||||
- `pk;token` - DMs you a token for using the PluralKit API.
|
||||
- `pk;token refresh` - Refreshes your API token and invalidates the old one.
|
||||
|
||||
## Help
|
||||
- `pk;help` - Displays a basic help message describing how to use the bot.
|
||||
- `pk;help proxy` - Directs you to [this page](/guide#proxying).
|
||||
- `pk;system help` - Lists system-related commands.
|
||||
- `pk;member help` - Lists member-related commands.
|
||||
- `pk;switch help` - Lists switch-related commands.
|
||||
- `pk;commands` - Directs you to this page!
|
||||
Loading…
Reference in New Issue
Block a user