From 4e6da8cfd258c7203ab582de1a4a6960c503ecc3 Mon Sep 17 00:00:00 2001 From: Noikoio Date: Sun, 15 Oct 2017 22:05:18 -0700 Subject: [PATCH] Added entity list documentation --- docs/docs/entitylist.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/docs/entitylist.md diff --git a/docs/docs/entitylist.md b/docs/docs/entitylist.md new file mode 100644 index 0000000..b73b106 --- /dev/null +++ b/docs/docs/entitylist.md @@ -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. \ No newline at end of file