Subject | Hash | Author | Date (UTC) |
---|---|---|---|
Updated README | 8e298151286ec3cb4df29633aaca90fc871f2e80 | Detche | 2016-10-23 10:10:45 |
Update README.rst | 7965df28cbef557fd3819919b4d44f0733dcecf0 | Guillaume | 2016-10-23 00:06:05 |
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.md | 11 | 15 |
File README.md renamed from README.rst (similarity 74%) (mode: 100644) (index cc5660c..ac39446) | |||
1 | ===== | ||
2 | Botly | ||
3 | ===== | ||
1 | # Botly | ||
4 | 2 | ||
5 | 3 | This is a bot base for Discord, made using Discord.py API. The base consists | This is a bot base for Discord, made using Discord.py API. The base consists |
6 | 4 | of an event handling core. It loads the reactions from the given parent module | of an event handling core. It loads the reactions from the given parent module |
7 | 5 | directory. The reactions consists of a hook to an event, a trigger that defines | directory. The reactions consists of a hook to an event, a trigger that defines |
8 | 6 | when it should activate and a reaction logic when it runs. | when it should activate and a reaction logic when it runs. |
9 | 7 | ||
10 | This project is private and no support is provided. | ||
8 | ## Dependencies | ||
11 | 9 | ||
12 | Dependencies | ||
13 | ============ | ||
10 | - Discord.py API: https://github.com/Rapptz/discord.py | ||
11 | - lxml | ||
14 | 12 | ||
15 | * Discord.py API: https://github.com/Rapptz/discord.py | ||
16 | * lxml | ||
17 | |||
18 | Usage | ||
19 | ===== | ||
13 | ## Usage | ||
20 | 14 | ||
21 | 15 | Install the dependencies: | Install the dependencies: |
22 | 16 | ||
23 | ``pip install discord.py`` | ||
24 | |||
25 | ``pip install lxml`` | ||
17 | ```bash | ||
18 | pip install discord.py | ||
19 | |||
20 | pip install lxml | ||
21 | ``` | ||
26 | 22 | ||
27 | 23 | Review the example robot for a presentation of the bot structure. It includes | Review the example robot for a presentation of the bot structure. It includes |
28 | a file documenting the available methods for event processing in the ``reactions`` | ||
24 | a file documenting the available methods for event processing in the `reactions` | ||
29 | 25 | directory. | directory. |
30 | 26 | ||
31 | 27 | The Discord bot token should be set in the XML database file. An example of | The Discord bot token should be set in the XML database file. An example of |