From 417e2c3c27b81ffd71e728500da1a0629c4c2ab9 Mon Sep 17 00:00:00 2001 From: Noikoio Date: Sun, 15 Oct 2017 20:50:35 -0700 Subject: [PATCH] Updated docs index; Adding serverdef --- docs/docs/index.md | 8 ++++---- docs/docs/serverdef.md | 11 +++++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) create mode 100644 docs/docs/serverdef.md diff --git a/docs/docs/index.md b/docs/docs/index.md index 982a197..8084802 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -5,7 +5,7 @@ Configuration takes the form of a JSON file name `settings.json`. Within this fi [Sample file for quick reference.](sample.html) -Here is a list of all accepted values. -* bot-token (*string*) - **Required.** Discord token used for connecting to the service. -* playing (*string*) - String to display as the bot's "now playing" status message. -* servers (*array*) - Takes an array of [server definitions](serverdef.html). \ No newline at end of file +The following is a list of all accepted values with links to pages explaining them in more detail. +* bot-token *(string)* - **Required.** Discord token used for connecting to the service. +* playing *(string)* - String to display as the bot's "now playing" status message. +* servers *(array)* - Takes an array of unnamed [server definition](serverdef.html) objects. \ No newline at end of file diff --git a/docs/docs/serverdef.md b/docs/docs/serverdef.md new file mode 100644 index 0000000..b957aaa --- /dev/null +++ b/docs/docs/serverdef.md @@ -0,0 +1,11 @@ +## Server definition + +Server definitions are defined within the `servers` array. Each definition represents unique configuration for a single server. Defining multiple servers allows for a single bot instance to be uniquely configured for use in several servers at once. + +The following is a list of accepted members within a server definition. +* name *(string)* - **Required.** A string containing the server ID, and optionally the name, of the server that this definition represents. + * If you wish to enter both a name and ID, you must first enter the ID, followed by two colon (:) characters, followed by the name. For example: `"285450825525927585::My Testing Server"` +* moderators *[(entity list)](entitylist.html)* - A list of entities to consider as moderators. Actions done by the members of those in this list are able to execute *ModTools* commands and are exempt from certain *AutoMod* rules if a particular rule has its *AllowModBypass* setting set to *false*. +* [AutoMod](automod.html) *(name/value pairs)* - Auto-moderation matching and response definitions. +* [AutoResponses](autorespond.html) *(name/value pairs)* - Definitions for automatic responses. +* [ModTools](modtools.html) *(name/value pairs)* - Moderation command definitions. \ No newline at end of file