Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/udoprog/OxidizeBot

High performance Twitch bot in Rust
https://github.com/udoprog/OxidizeBot

linux rust twitch twitch-bot windows-desktop

Last synced: about 2 months ago
JSON representation

High performance Twitch bot in Rust

Awesome Lists containing this project

README

        






Site 🌐

Command Help ❓

# oxidize
[github](https://github.com/udoprog/OxidizeBot)
[build status](https://github.com/udoprog/OxidizeBot/actions?query=branch%3Amain)
[chat on discord](https://discord.gg/v5AeNkT)

A high performance Twitch Bot powered by Rust.


## Features

**Commands** — Aliases, custom commands, promotions, plus [a bunch more](https://setbac.tv/help).

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).

[releases]: https://github.com/udoprog/OxidizeBot/releases


## Building

You'll need Rust and a working compiler: .

After this, you build the project using cargo:

```bash
cargo build
```

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

```bash
cargo run
```

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

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

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

[unstable feature]: https://doc.rust-lang.org/std/backtrace/index.html


## 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.

[open an issue]: https://github.com/udoprog/OxidizeBot/issues
[Rust]: https://rust-lang.org
[hundred settings]: https://github.com/udoprog/OxidizeBot/blob/main/bot/src/settings.yaml
[LICENSE-APACHE]: https://github.com/udoprog/OxidizeBot/blob/main/LICENSE-APACHE
[LICENSE-MIT]: https://github.com/udoprog/OxidizeBot/blob/main/LICENSE-MIT