Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.14 KB

README.md

File metadata and controls

79 lines (51 loc) · 2.14 KB
Raw

Welcome to ShoutBot 👋

Version License: GPL--3.0

This project is a bridge between TI-Planet shoutbox and Discord

Contribute:

If you find a bug, or want some feature you can open an issue. Otherwise you could create a pull request, and if the pull request is good we can think about merging it.

Setup:

Requirements

For this bot you need to install python3.8, pip and poetry. There is also a docker for easy deployment.

Install

You need to setup dependencies, in your terminal run :

poetry install

Config

For setting up the bot, you need :

  • A Discord bot
  • A TI-Planet account
  • A webhook in your shoutbox Discord channel

In config.json you will find every common settings that are not private.

In config_override.json you will find settings that are private such as your Discord bot token, your wehbook id and token, or your TI-Planet account. In this file you can overrite every setting you fin in config.json

Usage

To run the server, run in your terminal :

poetry run python main.py

Docker

You can easily setup this project using docker:

  1. First download docker-compose.yml and config.json and default config_override.json;
  2. Edit settings depending on your server (see config part);
  3. Run the docker using the following command :
  • run in foreground:
docker-compose up
  • run in background:
docker-compose up -d

if you need more help see the docker documentation

Licence

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See license for details.