diff --git a/docs/Custom Reactions.md b/docs/Custom Reactions.md new file mode 100644 index 00000000..49e365ac --- /dev/null +++ b/docs/Custom Reactions.md @@ -0,0 +1,69 @@ +##Custom Reactions +

Important

+ +###Commands and Their Use + + + + + + + + + + + + + + + + + + + + + +
Command NameDescriptionExample
.acrAdd a custom reaction with a trigger and a response. Running this command in a server requries the Administrator permission. Running this command in DM is Bot Owner only, and adds a new global custom reaction. Guide here: http://nadekobot.readthedocs.io/en/1.0/Custom Reactions/.acr "hello" Hi there, %user%!
.lcrLists a page of global or server custom reactions (15 reactions per page). Running this command in a DM will list the global custom reactions, while running it in a server will list that server's custom reactions..lcr 1
.dcrDeletes a custom reaction based on the provided index. Running this command in a server requires the Administrator permission. Running this command in DM is Bot Owner only, and will delete a global custom reaction..dcr 5
+ +

Now that we know the commands let's take a look at an example of adding a command with .acr,

+

.acr "Nice Weather" It sure is, %user%!

+

This command can be split into two different arguments:

+

Because we wanted the trigger to be more than one word, we had to wrap it with quotation marks, "Like this" otherwise, only the first word would have been recognised as the trigger, and the second word would have been recognised as part of the response.

+

There's no special requirement for the formatting of the response, so we could just write it in exactly the same way we want it to respond, albeit with a placeholder - which will be explained in this next section

+ +###Placeholders! +

There are currently three different placeholders which we will look at, with more placeholders potentially coming in the future.

+ + + + + + + + + + + + + + + + + + + + + + +
PlaceholderHow the placeholder worksExamples
%mention%The %mention% placeholder is triggered when you type @botname - It's important to note that if you've given the bot a nickname, this trigger won't work!.acr "%mention% Hello" Hello! > User input: @botname Hello | Bot Replies: Hello!
%user%The %user% placeholder mentions the person who said the command.acr "Who am I" You are %user%!
%rng%The %rng% generates a random number between 0 and 10.acr Random %rng% +
+ + Thanks to Nekai for being creative. <3