Subject | Hash | Author | Date (UTC) |
---|---|---|---|
Added README page | 8339ac5b13803b026dbfc5edd77fa50a24a70ecb | Detche | 2016-10-22 23:47:05 |
Added comments to sources. | ce6491ef1337ea34d33b7e4ede0eb9f634e7ab1a | Detche | 2016-10-22 23:32:26 |
Added examples. Modified reaction class to add triggers. | 545a35d1c5bb36e1b4e4d818b0e6a8f6642a222f | Detche | 2016-10-22 20:56:54 |
Initial commit | 2cd79df6224290a994b1453f0327740816b0f632 | Detche | 2016-10-21 16:21:02 |
File | Lines added | Lines deleted |
---|---|---|
README.rst | 36 | 0 |
File README.rst added (mode: 100644) (index 0000000..bf01e4f) | |||
1 | ===== | ||
2 | Botly | ||
3 | ===== | ||
4 | |||
5 | This is a bot base for Discord, made using Discord.py API. The base consists | ||
6 | of an event handling core. It loads the reactions from the given parent module | ||
7 | directory. The reactions consists of a hook to an event, a trigger that defines | ||
8 | when it should activate and a reaction logic when it runs. | ||
9 | |||
10 | This project is private and no support is provided. | ||
11 | |||
12 | Dependencies | ||
13 | ============ | ||
14 | |||
15 | * Discord.py API: https://github.com/Rapptz/discord.py | ||
16 | * lxml | ||
17 | |||
18 | Usage | ||
19 | ===== | ||
20 | |||
21 | Install the dependencies: | ||
22 | $ pip install discord.py | ||
23 | $ pip install lxml | ||
24 | |||
25 | Review the example robot for a presentation of the bot structure. It includes | ||
26 | a file documenting the available methods for event processing in the ``reactions`` | ||
27 | directory. | ||
28 | |||
29 | The Discord bot token should be set in the XML database file. An example of | ||
30 | this file is bundled with the example. | ||
31 | |||
32 | In your main, instantiate Botly along with the base module directory then the | ||
33 | UNIX path to the XML database file. | ||
34 | |||
35 | Run with python. | ||
36 |