WHEW. Added placeholders in embeds and quotes, added docs about it to explained features. Wrote a placeholder system and fixed some bugs
This commit is contained in:
@ -36,14 +36,4 @@ For example:
|
||||
Now if you try to trigger `/o/`, it won't print anything.
|
||||
|
||||
###Placeholders!
|
||||
There are currently three different placeholders which we will look at, with more placeholders potentially coming in the future.
|
||||
|
||||
| Placeholder | Description | Example Usage | Usage |
|
||||
|:-----------:|-------------|---------------|-------|
|
||||
|`%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!```|Input: "Hello @BotName" Output: "I, @BotName, also say hello!"|
|
||||
|`%user%`|The `%user%` placeholder mentions the person who said the command|`.acr "Who am I?" You are %user%!`|Input: "Who am I?" Output: "You are @Username!"|
|
||||
|`%rng%`|The `%rng%` placeholder generates a random number between 0 and 10. You can also specify a custom range (%rng1-100%) even with negative numbers: `%rng-9--1%` (from -9 to -1) . |`.acr "Random number" %rng%`|Input: "Random number" Output: "2"|
|
||||
|`%rnduser%`|The `%rnduser%` placeholder mentions a random user from the server. |`.acr "Random user" %rnduser%`|Input: "Random number" Output: @SomeUser|
|
||||
|`%target%`|The `%target%` placeholder is used to make Nadeko Mention another person or phrase, it is only supported as part of the response|`.acr "Say this: " %target%`|Input: "Say this: I, @BotName, am a parrot!". Output: "I, @BotName, am a parrot!".|
|
||||
|
||||
Thanks to Nekai for being creative. <3
|
||||
To learn about placeholders, go [here](Placeholders.md)
|
||||
|
24
docs/Placeholders.md
Normal file
24
docs/Placeholders.md
Normal file
@ -0,0 +1,24 @@
|
||||
Placeholders are used in Quotes, Custom Reactions, Greet/bye messages, playing statuses, and a few other places.
|
||||
|
||||
They can be used to make the message more user friendly, generate random numbers or pictures, etc...
|
||||
|
||||
Some features have their own specific placeholders which are noted in that feature's command help. Some placeholders are not available in certain features because they don't make sense there.
|
||||
|
||||
### Here is a list of the usual placeholders:
|
||||
- `%mention%` - Mention the bot
|
||||
- `%shardid%` - Shard id
|
||||
- `%server%` - Server name
|
||||
- `%sid%` - Server Id
|
||||
- `%channel%` - Channel mention
|
||||
- `%chname%` - Channel mention
|
||||
- `%cid%` - Channel Id
|
||||
- `%user%` - User mention
|
||||
- `%id%` or `%uid%` - User Id
|
||||
- `%userfull%` - Username#discriminator
|
||||
- `%userdiscrim%` - discriminator (for example 1234)
|
||||
- `%rngX-Y%` - Replace X and Y with the range (for example `%rng5-10%` - random between 5 and 10)
|
||||
- `%time%` - Bot time
|
||||
|
||||
**If you're using placeholders in embeds, don't use %user% and in titles, footers and field names. They will not show properly.**
|
||||
|
||||

|
@ -28,6 +28,7 @@ If you want to contribute, be sure to PR on the **[1.4][1.4]** branch.
|
||||
- [Permissions System](Permissions System.md)
|
||||
- [JSON Explanations](JSON Explanations.md)
|
||||
- [Custom Reactions](Custom Reactions.md)
|
||||
- [Placeholders](Placeholders.md)
|
||||
- [Frequently Asked Questions](Frequently Asked Questions.md)
|
||||
- [Contribution Guide](Contribution Guide.md)
|
||||
- [Donate](Donate.md)
|
||||
|
Reference in New Issue
Block a user