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

Index and layout updates

Browse source
This commit is contained in:
Noikoio 2017-10-15 20:17:13 -07:00
parent 0cbe074151
commit 4557c2fdb7
2 changed files with 10 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/_layouts/default.html
View file

@ -21,11 +21,9 @@
<div id="header"> <div id="header">
<nav> <nav>
<li class="fork"><a href="{{ site.github.repository_url }}">View On GitHub</a></li> <li class="fork"><a href="{{ site.github.repository_url }}">View On GitHub</a></li>
{% if site.show_downloads %}
<li class="downloads"><a href="{{ site.github.zip_url }}">ZIP</a></li> <li class="downloads"><a href="{{ site.github.repository_url }}/releases">Releases</a></li>
<li class="downloads"><a href="{{ site.github.tar_url }}">TAR</a></li> <li class="title"><a href="/docs">Documentation</a>></li>
<li class="title">DOWNLOADS</li>
{% endif %}
</nav> </nav>
</div><!-- end header --> </div><!-- end header -->

16
docs/index.md
View file

@ -5,31 +5,29 @@ title: RegexBot
Perhaps you already have all the bots you need, configured in just the right way to handle the day-to-day activity of your Discord server. But have you ever wanted to modify *that one thing* in order to finally make things perfect? Perhaps you already have all the bots you need, configured in just the right way to handle the day-to-day activity of your Discord server. But have you ever wanted to modify *that one thing* in order to finally make things perfect?
RegexBot is a moderation bot that on its own, does nothing. All aspects of its behavior are defined by its configuration. What this means is that each instance of RegexBot is uniquely suited to the server(s) it is configured to run on. RegexBot is a moderation bot that on its own, does nothing. All aspects of its behavior are defined through configuration. This means that each instance of RegexBot is uniquely suited to the server(s) it is configured to run on.
# Running the bot # Running the bot
There is no public instance of RegexBot ready to be invited to servers, and there are no plans to do so. Self-hosting the bot will be necessary to make use of it. There is no public instance of RegexBot ready to be invited to servers, and there are no plans to do so. Self-hosting the bot will be necessary to make use of it.
## Download links ### Download
Pre-compiled executables will be available soon. Until then, see below for instructions on how to compile the bot from source. Pre-compiled executables will be available soon. Until then, see below for instructions on how to compile the bot from source.
## Invite to server ### Make a bot account
You will need to get a bot token. To do so, [create an app in Discord](https://discordapp.com/developers/applications/me) and convert it into a Bot User. Make a note of the token and Client ID. **Do not share your bot token or put it in a public place.** You will need to get a bot token. To do so, [create an app in Discord](https://discordapp.com/developers/applications/me) and convert it into a Bot User. Make a note of the token and Client ID. **Do not share your bot token or put it in a public place.**
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`. 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 ### Configure
When starting, RegexBot looks for a file in the current directory named `settings.json`. Your bot token should be specified in this file. 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.
(This is still a draft. Config docs will be added soon.)
# Compiling from source # Compiling from source
## Prerequisites ### Prerequisites
The following must be installed: The following must be installed:
* Git * Git
* [.NET Core SDK](https://www.microsoft.com/net/core) 2.0 or later * [.NET Core SDK](https://www.microsoft.com/net/core) 2.0 or later
## Build the bot ### Build
With the prerequisites installed, run the following commands: With the prerequisites installed, run the following commands:
``` ```
$ git clone git@github.com:Noikoio/RegexBot.git $ git clone git@github.com:Noikoio/RegexBot.git