45 lines
3.5 KiB
Markdown
45 lines
3.5 KiB
Markdown
|
# Expressions
|
||
|
|
||
|
### Important
|
||
|
|
||
|
- For modifying **global** custom reactions, the ones which will work across all the servers Ellie is connected to, you **must** be a Bot Owner.
|
||
|
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, it is required 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
|
||
|
|
||
|
| Command Name | Description | Example |
|
||
|
| :----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
|
||
|
| `'exa` | Add an expression 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 expression. | `'exadd "hello" Hi there, %user%!` |
|
||
|
| `'exl` | Lists a page of global or server expression(15 expressions per page). Running this command in a DM will list the global expression, while running it in a server will list that server's expression. | `'exl 1` |
|
||
|
| `'exd` | Deletes an expression 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 expression. | `'exd 5` |
|
||
|
|
||
|
#### Now that we know the commands let's take a look at an example of adding a command with `'exa`,
|
||
|
|
||
|
`'exadd "Nice Weather" It sure is, %user%!`
|
||
|
|
||
|
This command can be split into two different arguments:
|
||
|
|
||
|
- The trigger, `"Nice Weather"`
|
||
|
- And the response, `It sure is, %user%!`
|
||
|
|
||
|
An important thing to note about the triger is that, 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.
|
||
|
|
||
|
Now, if that command was ran in a server, anyone on that server can make the bot mention them, saying `It sure is, @Username` anytime they say "Nice Weather". If the command is ran in a direct message with the bot, then the expression can be used on every server the bot is connected to.
|
||
|
|
||
|
### Block global Expressions
|
||
|
|
||
|
If you want to disable a global expression which you do not like, and you do not want to remove it, or you are not the bot owner, you can do so by adding a new expression with the same trigger on your server, and set the response to `-`.
|
||
|
|
||
|
For example:
|
||
|
`'exa /o/ -`
|
||
|
|
||
|
Now if you try to trigger `/o/`, it won't print anything even if there is a global expression with the same name.
|
||
|
|
||
|
### Placeholders!
|
||
|
|
||
|
To learn about placeholders, go [here](placeholders.md)
|