You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please note we do not officially support Windows or MacOS, but we do provide some instructions for those who want to use it on these platforms.
You do not explicitly need a conda environment for the bot to run. But it is always recommended nontheless, especially because the next LTS of Ubuntu won't let users pip-install anything without a virtual environment. At the time of writing, this bot requires python >= 3.9 to run.
# Clone the repository
git clone https://github.com/ThomasByr/useful-moderator.git
cd useful-moderator
You can create and activate a conda environment with the following commands :
# Install the dependencies
python -m pip install -r requirements.txt
Finally, run the bot in the background with bash run.bash or type the following :
# Run the bot (lets you Ctrl+C to stop it)
python useful_moderator.py
💁 Get Help
Inside the Discord app, you can type
/<GroupName> help
to get help about a specific group of commands. For example, you can type /utils help to get help about the utils group of commands.
You can try to ping the bot in your guild to start 👋 :
/utils ping
🔰 Support
🧪 Testing
🧑🏫 Contributing
If you ever want to contribute, either request the contributor status, or, more manually, fork the repo and make a full request !. On a more generic note, please do respect the Python Coding Conventions and wait for your PR to be reviewed. Make sure you respect and read the Contributing Guidelines, make pull requests and be kind.
The standard procedure is :
fork -> git branch -> push -> pull request
Note that we won't accept any PR :
that does not follow our Contributing Guidelines
that is not sufficiently commented or isn't well formated
without any proper test suite
with a failing or incomplete test suite
Happy coding ! 🙂
⚖️ License
⚖️ License
This project is licensed under the AGPL-3.0 new or revised license. Please read the LICENSE file. Additionally :
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Useful Moderator authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Useful Moderator - Discord Bot
Copyright (C) 2023 Thomas BOUYER
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.