pingex
/
DiscordBot
Archived
1
0
Fork 0
Code Issues 3 Releases Wiki Activity

Basic ReadMe

Browse Source
master
Pingex aka Raphaël 9 years ago
parent 2a21b44fcf
commit 3826632288
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File

22
readme.md
Unescape Escape View File

@ -1,2 +1,22 @@
# DiscordBot
Modular Bot for Discord, coming soon
## What is this
DiscordBot is just another bot written in Java. So basically it's a modular bot, which means you can create your own plugins to integrate with it. *coming soon*
## Getting started
* You need Java 8. Run `java -version` to check.
* You need to have the latest gradle installed, or dependencies won't resolve.
* Execute the following:
```
git clone https://git.pingex.net/pingex/DiscordBot
cd DiscordBot
gradle jar
```
* You can find the compiled jar in `build/libs/DiscordBot-X.Y.Z.jar`.
* Copy `config.example.ini` to `config.ini` and place it in the same directory as the jar. Then tweak it following your needs.
* Then `java -jar DiscordBot-X.Y.Z.jar` to run it.
Notes:
* No plugin will start by default. You need to enable them by specifying their full classname in the config file. (behavior to be changed)