Merge pull request #225 from dev-kittens/docs-fixes
Improve documentation
This commit is contained in:
Astrid
GitHub
commit
39155af2b8
@ -50,13 +50,13 @@ namespace PluralKit.Bot
|
||||
public static Command GroupList = new Command("group list", "group list", "Lists all groups in this system");
|
||||
public static Command GroupMemberList = new Command("group members", "group <group> list", "Lists all members in a group");
|
||||
public static Command GroupRename = new Command("group rename", "group <group> rename <new name>", "Renames a group");
|
||||
public static Command GroupDisplayName = new Command("group displayname", "group <member> displayname [display name]", "Changes a group's display name");
|
||||
public static Command GroupDisplayName = new Command("group displayname", "group <group> displayname [display name]", "Changes a group's display name");
|
||||
public static Command GroupDesc = new Command("group description", "group <group> description [description]", "Changes a group's description");
|
||||
public static Command GroupAdd = new Command("group add", "group <group> add <member> [member 2] [member 3...]", "Adds one or more members to a group");
|
||||
public static Command GroupRemove = new Command("group remove", "group <group> remove <member> [member 2] [member 3...]", "Removes one or more members from a group");
|
||||
public static Command GroupPrivacy = new Command("group privacy", "group <group> privacy <description|icon|visibility|all> <public|private>", "Changes a group's privacy settings");
|
||||
public static Command GroupDelete = new Command("group delete", "group <group> delete", "Deletes a group");
|
||||
public static Command GroupIcon = new Command("group icon", "group <group> icon [url|@mention]", "Changes a group's icon");
|
||||
public static Command GroupDelete = new Command("group delete", "group <group> delete", "Deletes a group");
|
||||
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");
|
||||
public static Command SwitchMove = new Command("switch move", "switch move <date/time>", "Moves the latest switch in time");
|
||||
@ -382,7 +382,7 @@ namespace PluralKit.Bot
|
||||
await PrintCommandNotFoundError(ctx, GroupCommandsTargeted);
|
||||
}
|
||||
else if (!ctx.HasNext())
|
||||
await PrintCommandNotFoundError(ctx, GroupCommands);
|
||||
await PrintCommandExpectedError(ctx, GroupCommands);
|
||||
else
|
||||
await ctx.Reply($"{Emojis.Error} {ctx.CreateGroupNotFoundError(ctx.PopArgument())}");
|
||||
}
|
||||
|
||||
@ -46,7 +46,7 @@ namespace PluralKit.Bot
|
||||
memberCount++;
|
||||
|
||||
// Send confirmation and space hint
|
||||
await ctx.Reply($"{Emojis.Success} Member \"{memberName}\" (`{member.Hid}`) registered! Check out the getting started page for how to get a member up and running: https://pluralkit.me/start#members");
|
||||
await ctx.Reply($"{Emojis.Success} Member \"{memberName}\" (`{member.Hid}`) registered! Check out the getting started page for how to get a member up and running: https://pluralkit.me/start#create-a-member");
|
||||
if (memberName.Contains(" "))
|
||||
await ctx.Reply($"{Emojis.Note} Note that this member's name contains spaces. You will need to surround it with \"double quotes\" when using commands referring to it, or just use the member's 5-character ID (which is `{member.Hid}`).");
|
||||
if (memberCount >= memberLimit)
|
||||
|
||||
@ -56,6 +56,21 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
|
||||
- `pk;member <name> delete` - Deletes a member.
|
||||
- `pk;random` - Shows the member card of a randomly selected member in your system.
|
||||
|
||||
## Group commands
|
||||
*Replace `<name>` with a group's name or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
|
||||
- `pk;group <name>` - Shows information about a group.
|
||||
- `pk;group new <name>` - Creates a new group.
|
||||
- `pk;group list` - Lists all groups in your system.
|
||||
- `pk;group <group> list` - Lists all members in a group.
|
||||
- `pk;group <group> rename <new name>` - Renames a group.
|
||||
- `pk;group <group> displayname [display name]` - Shows or changes a group's display name.
|
||||
- `pk;group <group> description [description]` - Shows or changes a group's description.
|
||||
- `pk;group <group> add <member> [member 2] [member 3...]` - Adds one or more members to a group.
|
||||
- `pk;group <group> remove <member> [member 2] [member 3...]` - Removes one or more members from a group.
|
||||
- `pk;group <group> privacy <description|icon|visibility|all> <public|private>` - Changes a group's privacy settings.
|
||||
- `pk;group <group> icon [icon]` - Shows or changes a group's icon.
|
||||
- `pk;group <group> delete` - Deletes a group.
|
||||
|
||||
## Switching commands
|
||||
- `pk;switch [member...]` - Registers a switch with the given members.
|
||||
- `pk;switch move <time>` - Moves the latest switch backwards in time.
|
||||
|
||||
@ -25,3 +25,39 @@ PluralKit has a couple of useful command shorthands to reduce the typing:
|
||||
|pk;switch|pk;sw|
|
||||
|pk;message|pk;msg|
|
||||
|pk;autoproxy|pk;ap|
|
||||
|
||||
## Member list flags
|
||||
There are a number of option flags that can be added to the `pk;system list` command.
|
||||
|
||||
### Sorting options
|
||||
|Flag|Aliases|Description|
|
||||
|---|---|---|
|
||||
|-by-name|-bn|Sort by member name (default)|
|
||||
|-by-display-name|-bdn|Sort by display name|
|
||||
|-by-id|-bid|Sort by member ID|
|
||||
|-by-message-count|-bmc|Sort by message count (members with the most messages will appear near the top)|
|
||||
|-by-created|-bc|Sort by creation date (members least recently created will appear near the top)|
|
||||
|-by-last-fronted|-by-last-front, -by-last-switch, -blf, -bls|Sort by most recently fronted|
|
||||
|-by-last-message|-blm, -blp|Sort by last message time (members who most recently sent a proxied message will appear near the top)|
|
||||
|-by-birthday|-by-birthdate, -bbd|Sort by birthday (members whose birthday is in January will appear near the top)|
|
||||
|-reverse|-rev, -r|Reverse previously chosen sorting order|
|
||||
|-random||Sort randomly|
|
||||
|
||||
### Filter options
|
||||
|Flag|Aliases|Description|
|
||||
|---|---|---|
|
||||
|-all|-a|Show all members, including private members|
|
||||
|-public-only|-public, -pub|Only show public members (default)|
|
||||
|-private-only|-private, -priv|Only show private members|
|
||||
|
||||
::: warning
|
||||
You cannot look up private members of another system.
|
||||
:::
|
||||
|
||||
### Additional fields to include in the search results
|
||||
|Flag|Aliases|Description|
|
||||
|---|---|---|
|
||||
|-with-last-switch|-with-last-fronted, -with-last-front, -wls, -wlf|Show each member's last switch date|
|
||||
|-with-last-message|-with-last-proxy, -wlm, -wlp|Show each member's last message date|
|
||||
|-with-message-count|-wmc|Show each member's message count|
|
||||
|-with-created|-wc|Show each member's creation date|
|
||||
Loading…
Reference in New Issue
Block a user