diff --git a/PluralKit.Bot/Commands/CommandTree.cs b/PluralKit.Bot/Commands/CommandTree.cs index 0a8aed08..3ec50e65 100644 --- a/PluralKit.Bot/Commands/CommandTree.cs +++ b/PluralKit.Bot/Commands/CommandTree.cs @@ -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 birthday [birthday]", "Changes a member's birthday"); public static Command MemberProxy = new Command("member proxy", "member proxy [add|remove] [example proxy]", "Changes, adds, or removes a member's proxy tags"); public static Command MemberDelete = new Command("member delete", "member delete", "Deletes a member"); - public static Command MemberAvatar = new Command("member avatar", "member avatar [url|@mention|clear]", "Changes a member's avatar"); - public static Command MemberServerAvatar = new Command("member serveravatar", "member serveravatar [url|@mention|clear]", "Changes a member's avatar in the current server"); + public static Command MemberAvatar = new Command("member avatar", "member avatar [url|@mention]", "Changes a member's avatar"); + public static Command MemberServerAvatar = new Command("member serveravatar", "member serveravatar [url|@mention]", "Changes a member's avatar in the current server"); public static Command MemberDisplayName = new Command("member displayname", "member displayname [display name]", "Changes a member's display name"); public static Command MemberServerName = new Command("member servername", "member servername [server name]", "Changes a member's display name in the current server"); public static Command MemberKeepProxy = new Command("member keepproxy", "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 privacy [on|off]", "Sets whether a member is private or public"); public static Command Switch = new Command("switch", "switch [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}; diff --git a/docs/3-command-list.md b/docs/3-command-list.md index 959ae420..26c93fad 100644 --- a/docs/3-command-list.md +++ b/docs/3-command-list.md @@ -7,10 +7,11 @@ nav_order: 3 --- # How to read this -Words in \ 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 **\** 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 \ 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 ` - Links this system to a different account. - `pk;unlink [account]` - Unlinks an account from this system. + ## Member commands +*Replace `` with a member's name or 5-character ID. For most commands, adding `-clear` will clear/delete the field.* - `pk;member ` - Shows information about a member. - `pk;member new ` - Creates a new system member. - `pk;member rename ` - Changes the name of a member. - `pk;member displayname ` - Changes the display name of a member. -- `pk;member servername ` - Changes the display name of a member, only in the current serve. +- `pk;member servername ` - Changes the display name of a member, only in the current server. - `pk;member description [description]` - Changes the description of a member. -- `pk;member avatar ` - Changes the avatar of a member. -- `pk;member serveravatar ` - Changes the avatar of a member in a specific server. +- `pk;member avatar ` - Changes the avatar of a member. +- `pk;member serveravatar ` - Changes the avatar of a member in a specific server. - `pk;member proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs. - `pk;member proxy add [tags]` - Adds a proxy tag pair to a member. - `pk;member proxy remove [tags]` - Removes a proxy tag from a member. @@ -46,23 +49,39 @@ Words in \ are *required parameters*. Words in [square brackets] - `pk;member birthdate [birthdate]` - Changes the birthday of a member. - `pk;member 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