Noi/RegexBot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added entity list documentation

Browse source
This commit is contained in:
Noikoio 2017-10-15 22:05:18 -07:00
parent db0673bc40
commit 4e6da8cfd2
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/docs/entitylist.md Normal file
View file

@ -0,0 +1,21 @@
## Entity list
An entity list is a JSON object with multiple values each containing arrays of strings. They are used in various places in the configuration to specify a number of users, roles, channels, or any combination thereof.
Here is a sample of an entity list:
```
{
"users": [ "@000000000000::MyName", "That Guy Over There" ],
"roles": [ "99999999999::Trusted", "Bots" ],
"channels": [ "#378237823782::random", "#usual" ]
}
```
As can be seen, all entities defined may either be specified using their name, or otherwise have their unique ID along with a label, separated by two colon (:) characters. Additionally, the ID should be prefixed with `@` if referring to a user or `#` if referring to a channel.
Each individual property is optional within an entity list, and is not necessary if your configuration does not require it. For example, this is a valid definition for an empty entity list:
```
{ }
```
It is **strongly recommended** to use unique IDs when defining entities with names that could change at any given time, such as users. Certain servers that frequently change role and channel names also benefit from having those IDs specified.