mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Custom Reactions rewritten in Markdown

Browse Source 
It's all in markdown now, rather than HTML!
Added clarification on how the placeholders are used.
`%target%`'s old implementation is there as a comment, ready for it's return
This commit is contained in:
Jordan Fearnley 2016-10-10 17:36:23 +01:00 committed by GitHub
parent 8db0b08bf3
commit 9561c06ad5
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Custom Reactions.md
View File

@ -1,7 +1,9 @@
##Custom Reactions ##Custom Reactions
###Important ###Important
* For modifying **global** custom reactions, the ones which will work across all the servers your bot is connected to, you **must** be a Bot Owner.<br> You must also use the commands for adding, deleting and listing these reactions in a direct message with the bot. * For modifying **global** custom reactions, the ones which will work across all the servers your bot is connected to, you **must** be a Bot Owner.
* For modifying **local** custom reactions, the ones which will only work on the server that they are added on, require you to have the **Administrator** permission.<br> You must also use the commands for adding, deleting and listing these reactions in the server you want the custom reactions to work on. You must also use the commands for adding, deleting and listing these reactions in a direct message with the bot.
* For modifying **local** custom reactions, the ones which will only work on the server that they are added on, require you to have the **Administrator** permission.
You must also use the commands for adding, deleting and listing these reactions in the server you want the custom reactions to work on.
###Commands and Their Use ###Commands and Their Use
| Command Name | Description | Example | | Command Name | Description | Example |
@ -28,9 +30,9 @@ There are currently three different placeholders which we will look at, with mor
| Placeholder | How the placeholder works | Example Usage | Input | Output | | Placeholder | How the placeholder works | Example Usage | Input | Output |
|:-----------:|---------------------------|---------------|-------|--------| |:-----------:|---------------------------|---------------|-------|--------|
|`%mention`|The `%mention%` placeholder is triggered when you type `@BotName` - It's important to note that if you've given the bot a custom nickname, this trigger won't work!|`.acr "Hello %mention%" I, %mention%, also say hello!`|Hello @BotName|I, @BotName, also say hello!| |`%mention`|The `%mention%` placeholder is triggered when you type `@BotName` - It's important to note that if you've given the bot a custom nickname, this trigger won't work!|`.acr "Hello %mention%" I, %mention%, also say hello!`|Hello @BotName|I, @BotName, also say hello!|
|`%user%`|The `%user%` placeholder mentions the person who said the command|`.acr "Who am I?" You are %user%!`|Who am I?|You are, @Username| |`%user%`|The `%user%` placeholder mentions the person who said the command|`.acr "Who am I?" You are %user%!`|Who am I?|You are @Username!|
|`%rng%`|The `%rng%` placeholder generates a random number between 0 and 10|`.acr "Random number" %rng%`|Random number|2| |`%rng%`|The `%rng%` placeholder generates a random number between 0 and 10|`.acr "Random number" %rng%`|Random number|2|
<!-- |`%target%`|The `%target%` placeholder is used to make Nadeko Mention another person or phrase|`.acr "Say this: " %target%|Say this: I, @BotName, am a parrot!|I, @BotName, am a parrot!| --> [//]: # (|`%target%`|The `%target%` placeholder is used to make Nadeko Mention another person or phrase|`.acr "Say this: " %target%|Say this: I, @BotName, am a parrot!|I, @BotName, am a parrot!|)
Thanks to Nekai for being creative. <3 <!-- and to fearnlj01, for making it less creative (sorry) --> Thanks to Nekai for being creative. <3