Giter Site home page Giter Site logo

togglebot's Introduction

๐Ÿค– ToggleBot

Build Status Twitch Discord

This is the ToggleBot bot used on togglebit's Discord server and Twitch chat.

Build

To build this project have rust and cargo available in the latest version and run cargo build. Now you will find the binary at target/debug/togglebot which you can directly execute or use cargo run for convenience.

Docker

This bot is hosted on my private server in a Docker container that is build with the local Dockerfile. The image is publicly available as dnaka91/togglebot and can be pulled with Docker.

To run the Docker image execute:

docker run -v $PWD/config.toml:/app/config.toml -v $PWD/temp:data dnaka91/togglebot
  • -v $PWD/config.toml:/app/config.toml maps the local configuration at the proper place in the container for the bot to find it.
  • -v $PWD/temp:data maps the data directory to a local folder which contains all state (like custom commands) for the bot.

Configuration

The bot expect to find a config file named config.toml at the current working directory or at /app/config.toml if the first one couldn't be found.

The following sections describe all configuration options of this bot.

Discord

For Discord only a token is needed. This can be created by first adding a new application on TODO and then activating the bot feature. There should be a button in the bot area to get the token.

Twitch

Twitch needs a login which is the user account and a token that can be generated at TODO. To make a bot user a new normal user account needs to be created as Twitch doesn't have bot users as a feature on its own.

Example

Here is a short example of a full config file with sample values.

[discord]
token = "xxx"

[twitch]
login = "botname"
token = "xxx"

License

This project is licensed under the AGPL-3.0 License (or https://www.gnu.org/licenses/agpl-3.0.html).

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.