https://github.com/jonathanvdc/taubot

A Reddit/Discord economy bot implementation.
https://github.com/jonathanvdc/taubot

Last synced: 15 days ago
JSON representation

A Reddit/Discord economy bot implementation.

• Host: GitHub
• URL: https://github.com/jonathanvdc/taubot
• Owner: jonathanvdc
• License: agpl-3.0
• Created: 2019-12-24T23:36:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-08T18:33:16.000Z (about 3 years ago)
• Last Synced: 2023-02-27T09:52:17.064Z (almost 2 years ago)
• Language: Python
• Homepage:
• Size: 506 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Taubot

This is a Reddit/Discord economy bot implementation in Python.

## Installation 

Taubot has a simple install script that will set up the database and install dependencies

```bash

./bin/install.sh

```

## Usage

The bot will need credentials to log into Reddit. Summarize them in a JSON file named `bot-config.json` placed in the directory from which you run the bot. A `bot-config.json` looks like this:

```json

{

  "reddit_client_id": "CLIENT_ID",

  "reddit_client_secret": "CLIENT_SECRET",

  "reddit_username": "USERNAME",

  "reddit_password": "PASSWORD",

  "discord_token": "BOT TOKEN",

  

  "server_key": "PEM PRIVATE RSA KEY",

  

  "prefix": ["Prefix 1", "Prefix 2", "etc"],

  "colour": "Hex code for embed colour",

  "server_type": "'ledger' for a ledger server and 'sql' for a sql server",

  "server_configuration": {

    "url": "An optional SQL database url that will override the other parameters",

    "dialect": "the dialect to use defaults to postgresql",

    "uname": "the username to connect with",

    "psswd": "the password to connect with",

    "db": "the database to connect to",

    "ledger_path": "if you are using a ledger server you only need to specify a ledger path"

  }

}

```

Please note that if any of the arguments are missing the bot will print a warning and gracefully degrade into not using the

associated feature

To make the bot respond to all unread messages, simply run `python3 src/bot.py`.