simongoricar / rAndroidRoot-bot

Discord bot for the r/AndroidRoot Discord server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rAndroidRoot-bot

Docker Build Status Docker Image Size (latest by date)

Discord bot for the r/AndroidRoot discord server

Setup

1. Installation

Before we begin: this project uses Poetry as the package manager, see this link for installation instructions. Additionally, Python 3.8 is required.

When you are ready, run poetry install in the directory where you cloned the bot. This will install the dependencies in a virtual env, as opposed to the global Python.

2. Configuration

Copy and fill out the provided configuration in data/config.EXAMPLE.ini. You will need to enter a bunch of IDs about your server and your bot token. If you want you can also customize the bot responses in data/strings.json, but keep in mind you need to use the name names for {placeholders}.

Also please note, the Server Members Intent is required for the !verifyall command.

3. Running

If you have completed the steps above, it's time to start the bot. Run either poetry run python bot.py or the provided shell scripts. I personally use screen to manage my bot (something like screen -dmS AndroidRootBot poetry run python bot.py), but that's not a requirement.

P.S. There is also a docker-compose.yml if you prefer using Docker.

Commands

Command Name Description
!verify Starts the verification process (if you are not yet verified)
!unverify Removes the verified role from you. Mostly a tester thing.
!verifyall [server owner only] Gives every member in the current server the verified role.
!about A bit about the bot, its version and its maker.
!help General help message, just like this table.
!ping Pong.

About

Discord bot for the r/AndroidRoot Discord server

License:MIT License


Languages

Language:Python 97.8%Language:Dockerfile 1.9%Language:Shell 0.3%