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: 3 days ago
JSON representation

High performance Twitch bot in Rust

• Host: GitHub
• URL: https://github.com/udoprog/oxidizebot
• Owner: udoprog
• License: apache-2.0
• Created: 2019-02-28T05:55:31.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T19:27:33.000Z (2 months ago)
• Last Synced: 2024-10-12T03:25:21.970Z (about 1 month ago)
• Topics: linux, rust, twitch, twitch-bot, windows-desktop
• Language: Rust
• Homepage: https://setbac.tv
• Size: 21.8 MB
• Stars: 156
• Watchers: 2
• Forks: 23
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        


    






Site 🌐

–

Command Help ❓

# oxidize

[](https://github.com/udoprog/OxidizeBot)

[](https://github.com/udoprog/OxidizeBot/actions?query=branch%3Amain)

[](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