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

Updated docs index; Adding serverdef

Browse source
This commit is contained in:
Noikoio 2017-10-15 20:50:35 -07:00
parent 5828f632fa
commit 417e2c3c27
2 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/index.md
View file

@ -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).
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.

11
docs/docs/serverdef.md Normal file
View file

@ -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.