A few help/error changes

This commit is contained in:
Ske 2018-12-09 16:33:57 +01:00
parent 72590ec92c
commit 478f96770b
2 changed files with 36 additions and 50 deletions

View File

@ -1,48 +1,3 @@
all_commands = """
**All commands**
```
pk;system [system]
pk;system new [system name
pk;system rename [new name]
pk;system description [new description]
pk;system avatar [new avatar url]
pk;system tag [new system tag]
pk;system delete
pk;system [system] fronter
pk;system [system] fronthistory
pk;system [system] frontpercent
pk;member new <member name>
pk;member <member>
pk;member <member> rename <new name>
pk;member <member> description [new description]
pk;member <member> avatar [new avatar url]
pk;member <member> proxy [example match]
pk;member <member> pronouns [new pronouns]
pk;member <member> color [new color]
pk;member <member> birthday [new birthday]
pk;member <member> delete
pk;switch <member> [<other member>...]
pk;switch move <time to move>
pk;switch out
pk;switch delete
pk;link <other account>
pk;unlink
pk;message <message id>
pk;log <log channel>
pk;invite
pk;import
pk;export
pk;token
pk;token refresh
```
**Command notes**
Parameters in <angle brackets> are required, [square brackets] are optional .
System references can be a system ID, a Discord account ID or a \\@mention.
Member references can be a member ID or, for your own system, a member name.
Leaving an optional parameter blank will often clear the relevant value.
"""
system_commands = """ system_commands = """
**System commands** **System commands**
@ -60,11 +15,6 @@ pk;system [system] frontpercent
pk;link <other account> pk;link <other account>
pk;unlink pk;unlink
``` ```
**Command notes**
Parameters in <angle brackets> are required, [square brackets] are optional .
System references can be a system ID, a Discord account ID or a \\@mention.
Leaving an optional parameter blank will often clear the relevant value.
""" """
member_commands = """ member_commands = """
@ -85,13 +35,40 @@ pk;switch move <time to move>
pk;switch out pk;switch out
pk;switch delete pk;switch delete
``` ```
"""
other_commands = """
**Other commands**
```
pk;log <log channel>
pk;message <message id>
pk;invite
pk;import
pk;export
pk;token
pk;token refresh
```
"""
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 .
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.
Leaving an optional parameter blank will often clear the relevant value. Leaving an optional parameter blank will often clear the relevant value.
""" """
all_commands = """
**All commands**
{}
{}
{}
{}
""".format(system_commands, member_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.
@ -103,6 +80,9 @@ You'll need to give the bot an "example match". Imagine you're proxying the word
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.
**Notes**
You can delete a proxied message by reacting to it with the :x: emoji from the sender's account.
""" """
root = """ root = """

View File

@ -103,6 +103,7 @@ async def send_proxy_message(conn, original_message: discord.Message, system: Sy
await db.add_message(conn, sent_message.id, original_message.channel.id, member.id, await db.add_message(conn, sent_message.id, original_message.channel.id, member.id,
original_message.author.id) original_message.author.id)
# Log it in the log channel if possible
await logger.log_message_proxied( await logger.log_message_proxied(
conn, conn,
original_message.channel.guild.id, original_message.channel.guild.id,
@ -128,6 +129,11 @@ async def send_proxy_message(conn, original_message: discord.Message, system: Sy
except discord.Forbidden: except discord.Forbidden:
raise ProxyError( raise ProxyError(
"PluralKit does not have permission to delete user messages. Please contact a server administrator.") "PluralKit does not have permission to delete user messages. Please contact a server administrator.")
except discord.NotFound:
# Sometimes some other thing will delete the original message before PK gets to it
# This is not a problem - message gets deleted anyway :)
# Usually happens when Tupperware and PK conflict
pass
async def try_proxy_message(conn, message: discord.Message, logger: ChannelLogger, bot_user: discord.User) -> bool: async def try_proxy_message(conn, message: discord.Message, logger: ChannelLogger, bot_user: discord.User) -> bool: