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

Revised; reorganized sections

Browse source
This commit is contained in:
Noikoio 2017-09-12 20:28:40 -07:00
parent 205943bd31
commit 5cbbb7ff08
1 changed files with 20 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/index.md
View file

@ -3,20 +3,31 @@ title: RegexBot
---
# Introduction
Perhaps you already have all the bots you need in your Discord server, configured just the right way to deal with day-to-day activity. 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?
This project is an answer to that. RegexBot is a moderation bot that does nothing on its own. All aspects of its behavior are defined in 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 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.
# Running the bot
There are no plans for the developer to run a public bot at the moment. There is no "main" instance of RegexBot. Self-hosting is necessary.
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
Pre-compiled executables will be available soon. Until then, see below for instructions on how to compile the bot from source.
## Invite to server
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`.
## Configure
When starting, RegexBot looks for a file in the current directory named `settings.json`. Your bot token should be specified in this file.
(This is still a draft. Config docs will be added soon.)
# Compiling from source
## Prerequisites
Unfortunately, precompiled executables are not yet available, so you'll need to compile it. To do so, you'll need the following installed on the device that will run the bot:
The following must be installed:
* Git
* [.NET Core SDK](https://www.microsoft.com/net/core) >= 2.0.0
In addition to that, you will need 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.**
* [.NET Core SDK](https://www.microsoft.com/net/core) 2.0 or later
## Build the bot
With the prerequisites installed, run the following commands:
@ -32,8 +43,4 @@ At this point, the bot has been compiled and all dependencies placed in the `out
$ cd output
$ dotnet RegexBot.dll
```
You may place the output directory wherever it's most convenient for you.
## Configure
The bot will not function without a configuration file.
You may move and rename the output directory at your convenience.