From 2a2808ccf2898b9892a37b616244f8d44674cdd7 Mon Sep 17 00:00:00 2001 From: Noikoio Date: Sun, 19 Nov 2017 16:54:39 -0800 Subject: [PATCH] Updated readme and docs --- README.md | 11 +++++------ docs/_layouts/default.html | 2 +- docs/{docs => }/automod.md | 0 docs/{docs => }/autorespond.md | 0 docs/docs.md | 25 +++++++++++++++++++++++++ docs/docs/index.md | 11 ----------- docs/{docs => }/entitylist.md | 0 docs/index.md | 2 +- docs/{docs => }/modtools.md | 0 docs/{docs => }/serverdef.md | 0 10 files changed, 32 insertions(+), 19 deletions(-) rename docs/{docs => }/automod.md (100%) rename docs/{docs => }/autorespond.md (100%) create mode 100644 docs/docs.md delete mode 100644 docs/docs/index.md rename docs/{docs => }/entitylist.md (100%) rename docs/{docs => }/modtools.md (100%) rename docs/{docs => }/serverdef.md (100%) diff --git a/README.md b/README.md index 3bc56e9..dea43d3 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,11 @@ RegexBot is a standalone Discord moderation bot that makes use of the [Discord.Net](https://github.com/RogueException/Discord.Net) library. -The goal of this project is to provide a bot that can truly fit your unique needs in managing Discord server. -To that end, many aspects of the bot's behavior can be configured and fine-tuned, down to how it responds to -rules that you have implemented. +The goal of this project is to provide a bot that can truly fit your unique needs in managing Discord server. To that end, many aspects of the bot's behavior can be configured and fine-tuned, ensuring that the bot acts exactly as you want it to act. -Are you satisfied with your current bot but wish that you could change *that one thing* to better suit your -needs? This project is an answer to that. +Are you satisfied with your current bot but wish that you could change *that one thing* to better suit your needs? This project is an answer to that. + +Granted, progress on this project so far has followed the needs of one Discord server that makes heavy use of it, so its current feature set may be limited. Feel free to send a pull request or submit an issue. ## Documentation -Documentation is available in the form of a number of pages hosted by Github Pages. See [this link](https://noikoio.github.com/RegexBot) or the [docs directory](https://github.com/Noikoio/RegexBot/tree/master/docs) for more information. \ No newline at end of file +Documentation is available in the form of a number of pages hosted by Github Pages. See [this site](https://noikoio.github.io/RegexBot) or the [site's source directory](https://github.com/Noikoio/RegexBot/tree/master/docs) for more information. \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 007cf77..2fe479e 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -23,7 +23,7 @@
  • View On GitHub
  • Releases
    • -
  • Documentation
    • +
  • Documentation
    • diff --git a/docs/docs/automod.md b/docs/automod.md similarity index 100% rename from docs/docs/automod.md rename to docs/automod.md diff --git a/docs/docs/autorespond.md b/docs/autorespond.md similarity index 100% rename from docs/docs/autorespond.md rename to docs/autorespond.md diff --git a/docs/docs.md b/docs/docs.md new file mode 100644 index 0000000..694708d --- /dev/null +++ b/docs/docs.md @@ -0,0 +1,25 @@ +# Documentation + +**Important note: Documentation is a work in progress and may be incomplete in some areas.** + +RegexBot has no default behavior of its own. It is up to the bot operator to define all aspects of its function, down to its triggers and commands to be used by moderators. + +Its configuration takes the form of a JSON file residing in the executable directory, named `settings.json`. Within this file should be one nameless JSON object, which itself should contain named values described near the bottom of this page. Additionally, the JSON parser treats text following double slashes as comments. + +The following is a sample configuration file: +``` +{ + "bot-token": "AbCDEf-gh1JKLmn0pqR$Tu.vwXyZ", + "playing": "with my preferred text editor", + "servers": [ + { + // (server configuration goes here) + } + ] +} +``` + +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/index.md b/docs/docs/index.md deleted file mode 100644 index 8084802..0000000 --- a/docs/docs/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Documentation -On its own, RegexBot has no default behavior. It is up to the user to define everything, including triggers and commands for use by moderators. - -Configuration takes the form of a JSON file name `settings.json`. Within this file should be one object, which itself contained named values. - -[Sample file for quick reference.](sample.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. \ No newline at end of file diff --git a/docs/docs/entitylist.md b/docs/entitylist.md similarity index 100% rename from docs/docs/entitylist.md rename to docs/entitylist.md diff --git a/docs/index.md b/docs/index.md index aff1200..f783080 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,7 +19,7 @@ You will need to get a bot token. To do so, [create an app in Discord](https://d Once you have created your Discord app, go to the following URL after inserting your client ID where specified: `https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID&scope=bot`. ### Configure -When starting or reloading, RegexBot looks for a file in its current directory named `settings.json`. The configuration file is too complex to explain simply here. [Check the documentation](./docs) to find a sample configuration file, as well as more detailed information. +When starting or reloading, RegexBot looks for a file in its current directory named `settings.json`. The configuration file is too complex to explain simply here. [Check the documentation](docs.html) to find a sample configuration file, as well as more detailed information. # Compiling from source ### Prerequisites diff --git a/docs/docs/modtools.md b/docs/modtools.md similarity index 100% rename from docs/docs/modtools.md rename to docs/modtools.md diff --git a/docs/docs/serverdef.md b/docs/serverdef.md similarity index 100% rename from docs/docs/serverdef.md rename to docs/serverdef.md