Skip to content

Commit

Permalink
And thus, the bot was.
Browse files Browse the repository at this point in the history
  • Loading branch information
0x5c committed Dec 23, 2019
1 parent d80d0c3 commit a370bef
Show file tree
Hide file tree
Showing 14 changed files with 216 additions and 284 deletions.
9 changes: 3 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@

# --- quick-bot-no-pain ---

# Settings and keys
data/options.py
data/keys.py
# Instance data
/data/*

# Virtual environments
botenv/
venv/
env/
*env/

# Editors & IDEs
.vscode/
Expand Down
18 changes: 18 additions & 0 deletions GHANGELOG.md
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
28 changes: 12 additions & 16 deletions README-DOCKER.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Docker help for {{bot}}
# Docker help for Minibot

You have multiple options to run an instance of {{bot}} using docker.
You have multiple options to run an instance of Minibot using docker.

- [Docker help for {{bot}}](#docker-help-for-bot)
- [Docker help for Minibot](#docker-help-for-minibot)
- [Using docker-compose and the prebuilt-image (recommended)](#using-docker-compose-and-the-prebuilt-image-recommended)
- [Using docker-compose and building the image](#using-docker-compose-and-building-the-image)
- [Using pure docker](#using-pure-docker)
- [[Optional] Building the image](#optional-building-the-image)
- [Creating the container](#creating-the-container)


<!-- !! ONLY include this part if you provide a prebuilt image !!
## Using docker-compose and the prebuilt-image (recommended)

This is the easiest method for running the bot without any modifications.
Expand All @@ -23,8 +22,8 @@ This is the easiest method for running the bot without any modifications.
```yaml
version: '3'
services:
{{bot}}:
image: "{{user}}/{{image}}:latest"
minibot:
image: "0x5c/minibot:latest"
restart: on-failure
volumes:
- "./data:/app/data:rw"
Expand All @@ -44,7 +43,6 @@ This is the easiest method for running the bot without any modifications.
```

> Run without "-d" to test the bot. (run in foreground)
-->


## Using docker-compose and building the image
Expand All @@ -58,9 +56,9 @@ This is the easiest method to run the bot with modifications.
```yaml
version: '3'
services:
{{bot}}:
minibot:
build: .
image: "{{image}}:local-latest"
image: "minibot:local-latest"
restart: on-failure
volumes:
- "./data:/app/data:rw"
Expand Down Expand Up @@ -96,7 +94,7 @@ This methods is not very nice to use.
2. Run docker build:

```none
$ docker build -t {{image}}:local-latest .
$ docker build -t minibot:local-latest .
```


Expand All @@ -107,11 +105,9 @@ This methods is not very nice to use.
2. Run the container:

```none
$ docker run -d --rm --mount type=bind,src=$(pwd)/data,dst=/app/data --name {{bot}} [image]
$ docker run -d --rm --mount type=bind,src=$(pwd)/data,dst=/app/data --name minibot [image]
```

Where `[image]` is either of:
- `{{image}}:local-latest` if you are building your own.
<!-- !! ONLY include this part if you provide a prebuilt image !!
- `{{user}}/{{image}}:latest` if you want to use the prebuilt image.
-->
- `minibot:local-latest` if you are building your own.
- `0x5c/minibot:latest` if you want to use the prebuilt image.
50 changes: 21 additions & 29 deletions README.md
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 removed docs/coolcry.png
Binary file not shown.
44 changes: 0 additions & 44 deletions docs/docker.md

This file was deleted.

Binary file removed docs/github-templates.png
Binary file not shown.
58 changes: 0 additions & 58 deletions docs/makefile.md

This file was deleted.

54 changes: 0 additions & 54 deletions docs/run.sh.md

This file was deleted.

Loading

0 comments on commit a370bef

Please sign in to comment.