alisonjenkins / oxidizebot Goto Github PK

A high performance Twitch Bot powered by Rust

Features

Commands — Aliases, custom commands, promotions, plus a bunch more.

If there's something you're missing, feel free to open an issue.

Rust — Written in Rust, promoting high performance, low utilization, and reliability.

Configurable — Everything is tweakable to suit your needs through a hundred settings. Changes to settings applies immediately - no need to restart.

Integrated with Windows — Runs in the background with a System Tray. Notifies you on issues. Starts automatically with Windows if you want it to.

Installing and Running

You can download an installer or an archive from releases or build the project yourself.

Building

You'll need Rust and a working compiler: https://rustup.rs/

After this, you build the project using cargo:

cargo build

If you want to run it directly from the project directory, you can do:

cargo run

If you want to run the bot with the most amount of diagnostics possible, you can do the following:

env RUST_BACKTRACE=1 cargo +nightly run -- --log oxidize=trace

This will include backtraces on errors, which is currently an unstable feature.

License

OxidizeBot is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE, LICENSE-MIT for details.