liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated help.py with more information/fixes

Browse Source
This commit is contained in:
Bella | Nightshade 2019-03-23 19:25:03 +09:30 committed by Astrid
parent 0166310a37
commit 0aea658af9
1 changed files with 38 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
src/pluralkit/bot/help.py
View File

@ -1,12 +1,12 @@
system_commands = """ system_commands = """
**System commands** __**System commands**__
Commands for adding, removing, editing, and linking systems, as well as querying fronter and front history. Commands for adding, removing, editing, and linking systems, as well as querying fronter and front history.
``` ```
pk;system [system] pk;system [system]
pk;system new [system name] pk;system new [system name]
pk;system rename [new name] pk;system rename [new name]
pk;system description [new description] pk;system description [new description]
pk;system avatar [new avatar url] pk;system avatar [new avatar URL]
pk;system tag [new system tag] pk;system tag [new system tag]
pk;system timezone [city/town] pk;system timezone [city/town]
pk;system delete pk;system delete
@ -14,21 +14,20 @@ pk;system [system] fronter
pk;system [system] fronthistory pk;system [system] fronthistory
pk;system [system] frontpercent pk;system [system] frontpercent
pk;system [system] list pk;system [system] list
pk;link <other account> pk;link <@other account>
pk;unlink pk;unlink
``` ```
""".strip() """.strip()
member_commands = """ member_commands = """
**Member commands** __**Member commands**__
Commands for adding, removing, and modifying members, as well as adding, removing and moving switches. Commands for adding, removing, and modifying members, as well as adding, removing and moving switches.
``` ```
pk;member new <member name> pk;member new <member name>
pk;member <member> pk;member <member>
pk;member <member> rename <new name> pk;member <member> rename <new name>
pk;member <member> description [new description] pk;member <member> description [new description]
pk;member <member> avatar [new avatar url] pk;member <member> avatar [new avatar URL/@username]
(Please bear in mind that your avatar image has to have 1 dimension 1024 pixels or less, i.e. 1024x2000 or 2500x1024, otherwise it will not stick!)
pk;member <member> proxy [example match] pk;member <member> proxy [example match]
pk;member <member> pronouns [new pronouns] pk;member <member> pronouns [new pronouns]
pk;member <member> color [new color] pk;member <member> color [new color]
@ -39,10 +38,11 @@ pk;switch move <time to move>
pk;switch out pk;switch out
pk;switch delete pk;switch delete
``` ```
**Please bear in mind that your avatar image has to have 1 dimension 1024 pixels or less, i.e. 1024x2000 or 2500x1024, and be 1 MB or less in size otherwise it will not stick!**
""".strip() """.strip()
help_commands = """ help_commands = """
**Help commands** __**Help commands**__
``` ```
pk;help pk;help
pk;help commands pk;help commands
@ -52,10 +52,10 @@ pk;help proxy
```""".strip() ```""".strip()
other_commands = """ other_commands = """
**Other commands** __**Other commands**__
``` ```
pk;log <log channel> pk;log <log channel>
pk;message <message id> pk;message <message ID>
pk;invite pk;invite
pk;import pk;import
pk;export pk;export
@ -65,9 +65,9 @@ pk;token refresh
""".strip() """.strip()
command_notes = """ command_notes = """
**Command notes** __**Command notes**__
Parameters in <angle brackets> are required, [square brackets] are optional . Parameters in <angle brackets> are required, [square brackets] are optional. **Do not include the brackets themselves when using the command.**
Member references can be a member ID or, for your own system, a member name. Member references can be a member ID or, for your own system, a member name. **If a member name contains spaces, it must be wrapped in "quotation marks" when being referenced (but not during creation).**
Leaving an optional parameter blank will often clear the relevant value. Leaving an optional parameter blank will often clear the relevant value.
""".strip() """.strip()
@ -77,16 +77,16 @@ all_commands = """
{} {}
{} {}
{} {}
""".strip().format(system_commands, member_commands, help_commands, other_commands, command_notes) """.strip().format(system_commands, member_commands + "\n", help_commands, other_commands, command_notes)
proxy_guide = """ proxy_guide = """
**Proxying** __**Proxying**__
Proxying through PluralKit lets system members have their own faux-account with their name and avatar. Proxying through PluralKit lets system members have their own faux-account with their name and avatar.
You'll type a message from your account in *proxy tags*, and PluralKit will recognize those tags and repost the message with the proper details. You'll type a message from your account in *proxy tags*, and PluralKit will recognize those tags and repost the message with the proper details, with the minor caveat of having the **[BOT]** icon next to the name (this is a Discord limitation and cannot be circumvented).
To set up a member's proxy tag, use the `pk;member <name> proxy [example match]` command. To set up a member's proxy tag, use the `pk;member <name> proxy [example match]` command.
You'll need to give the bot an "example match". Imagine you're proxying the word "text", and add that to the end. You'll need to give the bot an "example match" containing the word `text`. Imagine you're proxying the word "text", and add that to the end of the command.
For example: `pk;member John proxy [text]`. That will set the member John up to use square brackets as proxy tags. For example: `pk;member John proxy [text]`. That will set the member John up to use square brackets as proxy tags.
Now saying something like `[hello world]` will proxy the text "hello world" with John's name and avatar. Now saying something like `[hello world]` will proxy the text "hello world" with John's name and avatar.
You can also use other symbols, letters, numbers, et cetera, as prefixes, suffixes, or both. `J:text`, `$text` and `text]` are also examples of valid example matches. You can also use other symbols, letters, numbers, et cetera, as prefixes, suffixes, or both. `J:text`, `$text` and `text]` are also examples of valid example matches.
@ -96,21 +96,36 @@ You can delete a proxied message by reacting to it with the :x: emoji from the s
""".strip() """.strip()
root = """ root = """
**PluralKit** __**PluralKit**__
PluralKit is a bot designed for plural communities on Discord. It allows you to register systems, maintain system information, set up message proxying, log switches, and more. PluralKit is a bot designed for plural communities on Discord. It allows you to register systems, maintain system information, set up message proxying, log switches, and more.
**Getting started** **Who's this for? What are systems?**
Put simply, a system is a person that shares their body with at least 1 other sentient "self". This may be a result of having a dissociative disorder like DID/OSDD or a practice known as Tulpamancy, but people that aren't tulpamancers or undiagnosed and have headmates are also systems.
**Why are people's names saying [BOT] next to them? What's going on?**
These people are not actually bots, this is simply a caveat to the message proxying feature of PluralKit.
Type `pk;help proxy` for an in-depth explanation.
__**Getting started**__
To get started using the bot, try running the following commands. To get started using the bot, try running the following commands.
**1**. `pk;system new` - Create a system if you haven't already **1**. `pk;system new` - Create a system if you haven't already
**2**. `pk;member add John` - Add a new member to your system **2**. `pk;member add John` - Add a new member to your system
**3**. `pk;member John proxy [text]` - Set up square brackets as proxy tags **3**. `pk;member John proxy [text]` - Set up square brackets as proxy tags
**4**. You're done! **4**. You're done!
**More information** **5**. Optionally, you may set an avatar from the URL of an image with:
For a full list of commands, type `pk;help commands`. `pk;member John avatar [link to image]`
For a more in-depth explanation of proxying, type `pk;help proxy`. Type `pk;help member` for more information.
If you're an existing user of the Tupperware proxy bot, type `pk;import` to import your data from there.
**Support server** **Useful tip:**
You can delete a proxied message by reacting to it with :x: (if you sent it!).
__**More information**__
For a full list of commands, type `pk;help commands`.
For a more in-depth explanation of message proxying, type `pk;help proxy`.
If you're an existing user of the Tupperbox proxy bot, type `pk;import` to import your data from there.
__**Support server**__
We also have a Discord server for support, discussion, suggestions, announcements, etc: <https://discord.gg/PczBt78> We also have a Discord server for support, discussion, suggestions, announcements, etc: <https://discord.gg/PczBt78>
""".strip() """.strip()