Giter Site home page Giter Site logo

randroidroot-bot's Introduction

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.

randroidroot-bot's People

Contributors

milkmgn avatar simongoricar avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

milkmgn

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.