-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.rst.in
106 lines (57 loc) · 3.93 KB
/
README.rst.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# DecoraterBot Async Version
[](https://www.codacy.com/app/AraHaan/DecoraterBot?utm_source=github.com&utm_medium=referral&utm_content=AraHaan/DecoraterBot&utm_campaign=badger)
[](https://github.com/DecoraterBot-devs/DecoraterBot/issues)
## What is DecoraterBot?
DecoraterBot is an extendable Discord bot that is written in [Python](https://www.python.org/). It is currently maintained and developed by @[AraHaan](https://github.com/AraHaan), @[DavidNeon](https://github.com/DavidNeon), and rarely @[JakesDen](https://github.com/jakesden).
## Contributors
@[AraHaan](https://github.com/AraHaan) - Bot Developer
<!--
CheeseCast is sadly no longer part of Documentation. :cry: He just does not want issues with projects like this.
@[CheeseCast](https://github.com/CheeseCast) - Documentation & Spell-checker.. (hue)
-->
@[DavidNeon](https://github.com/DavidNeon) - Bot Developer, Code Changer, & More.
@[JakesDen](https://github.com/jakesden) - Assistant Bot Developer, Code Changer, & More.
## Commands
View the list of bot commands [here](https://github.com/DecoraterBot-devs/DecoraterBot-docs/blob/master/Commands.md).
## Future Updates
The bot gets updated and tested regularly. Pushes are released when features are stable.
## Description
The ``description.rst.in``, ``description.rst``, and the ``description.html`` files are used to generate the bot's description [here](https://discord.bots.gg/bots/104976661711179776).
## Rewrites
This bot from time to time might go through some rewrites to fix major and minor bugs in code.
Because of such it might sometimes means that it drops support for other things.
## Submitting Plugins
As of April 8th 2017 it is now not recommended to submit plugins to this repository. Submit them to [here](https://github.com/DecoraterBot-devs/DecoraterBot-cogs) as a pull request instead.
## Configuration
To get the cogs, run ``git clone https://github.com/DecoraterBot-devs/DecoraterBot-cogs.git cogs`` in the root of your current clone to the bot.
This is so that they can be imported properly by the utils package.
To run this bot you will need 2 things:
> A working Discord Bot Token.
> Your Account ID
Configuration is in ``\\resources\\ConfigData\\``.
Before setting configuration be sure to copy ``Credentials_example.json`` to ``Credentials.json``.
More Documentation on setting that file is [here](/Credentials.md).
After you have configured the bot with a token you can run the bot like so:
# Windows
First install dependencies with (will also upgrade pip, setuptools, and wheel for you as well):
> py -m pip install -U -r requirements.txt
Now you should be able to run the bot with:
> py -m DecoratorBot
# Linux and MacOS
First install dependencies with (will also upgrade pip, setuptools, and wheel for you as well):
> python3.11 -m pip install -U -r requirements.txt
Now you should be able to run the bot with:
> python3.11 -m DecoratorBot
Cant install python 3.11? Try using ``.pyenv`` and tell it to install 3.11 for you (perfect also when you do not have root access and need to get the bot ready).
Note: This bot also may require the python's C include files to install packages containing extension modules if they do not offer a prebuilt wheel for them.
# Other Platforms
This bot should work on other platforms as well, provided that all the dependencies work for it as well.
## Want to help with the bot?
<!--
Join the official Cheese.lab servers to help test and contribute to the development of the bot.
[](https://discord.gg/lab)
-->
Join the Bot's Original Server (Kinda dead right now):
[](https://discord.gg/cRr2TpR)
*Documentation isn't finished yet.*