generated from 0x5c/quick-bot-no-pain
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
216 additions
and
284 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Changelog for Minibot | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres (somewhat) to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
|
||
## [Unreleased] | ||
|
||
|
||
## [1.0.0] - 2019-12-23 | ||
### Added | ||
- Autorole system | ||
|
||
|
||
[Unreleased]: https://github.com/0x5c/minibot/compare/v1.0.0...HEAD | ||
[1.0.0]: https://github.com/0x5c/minibot/releases/tag/v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,43 @@ | ||
# *Quick tools for painless Discord bots* | ||
*Don't let your bot development become that:* ![:coolcry:](./docs/coolcry.png) | ||
# Minibot, a bot for basic server stuff | ||
|
||
[![Discord](https://img.shields.io/discord/591099017492955166?color=%237289DA&label=Discord)](https://discordapp.com/invite/6reX7e) | ||
[![Discord](https://discordapp.com/api/guilds/591099017492955166/widget.png?style=shield)](https://discordapp.com/invite/6reX7e) | ||
|
||
A collection of tools to aid in creating and using discord.py bots, painlessly. | ||
A small bot for basic guild stuff. | ||
|
||
Includes: | ||
- Autorole | ||
- ~~Purge command~~ *Soon™* | ||
|
||
## Tools | ||
|
||
*Click on the tool names to skip to documentation:* | ||
## Usage | ||
|
||
- [Makefile](./docs/makefile.md) Setup script for venv and more | ||
1. Setup a venv and install the dependencies. | ||
```none | ||
$ make install | ||
``` | ||
- [run.sh](./docs/run.sh.md) Simple startup script that handles restarting/exiting the bot | ||
2. Start the bot. | ||
```none | ||
$ ./run.sh | ||
``` | ||
- [Skeleton files](./docs/skeleton.md) Minimal templates of important and often missed bot files | ||
*For advanced usage of the makefile and run script, refer to the documentation in [0x5c/quick-bot-no-pain](https://github.com/0x5c/quick-bot-no-pain).* | ||
- [Docker files](./docs/docker.md) Docker-related files | ||
> **Windows:** Usage of most of these on Windows is untested, but should not cause problems with mingw64, MSYS/2, and such. | ||
> Well... *probably.* | ||
## Docker | ||
*Refer to instructions [here](./README-DOCKER.md).* | ||
## Repository template | ||
To use this repository as a base for your new bot, just use the *Template* feature of GitHub: | ||
![GitHub template button](./docs/github-templates.png) | ||
Feel free to remove any file you do not wish to use. | ||
## Built using 0x5c/quick-bot-no-pain | ||
|
||
## Changelog | ||
|
||
Changelogs for individual tools are in the tools' documentation files. | ||
|
||
- [2019-12-23] Added Docker files. | ||
- [2019-11-24] v2.0.0 - Stable snapshot - Moved option/keys to "./data". | ||
- [2019-10-06] Added `Makefile`, `run.sh`, and skeleton files. | ||
Get straight to coding, as-soon as the idea strikes: [try it for yourself!](https://github.com/0x5c/quick-bot-no-pain) | ||
## License | ||
Copyright (c) 2019 0x5c | ||
This project is released under the MIT license. | ||
This project is released under the terms of the MIT license. | ||
See `LICENSE` for the full license text. | ||
|
||
**Some parts** of this project are released under the terms of the Unlicense, | ||
and are identified as such in their documentation file. | ||
See the relevant documentation files for the full license text. |
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.