Rivet

Table of Content

• About
  • Terms of Service Notice
• Installation (AUR)
• Installation (Binaries)
• Installation (Cargo)
  • Dependencies
  • Compilation from crates.io
  • Compilation from source
• Initialization
• Usage
• Licence

About

[!NOTE] A Terminal UI Discord Client in Rust.

[!TIP] Having NerdFonts installed provides a better experiences with icons.

Terms of Service Notice

[!WARNING] Under no circumstances should you use a Discord User Token (also known as a self-bot token) with this software or any associated tools.

Discord's Terms of Service (ToS) explicitly and strictly prohibit the use of User Tokens for programmatic access or self-botting. Violation of these terms can lead to permanent termination of your Discord account.

• Do not use self-bots or user-bots. Each account must be associated with a human, not a bot. Self-bots put strain on Discord’s infrastructure and our ability to run our services. For more information, you can read our Developer Policies here.

The developers, contributors, and maintainers of this repository disclaim all liability and responsibility for any and all consequences that may arise from a user's decision to violate Discord's Terms of Service.

[!CAUTION] We do not encourage, endorse, or support the use of User Tokens. 😉

The user assumes all risk for any account actions, bans, or penalties issued by Discord due to improper use of this software.

Installation (AUR)

[!IMPORTANT] Make sure to have YaY installed.

yay -S rivetui
# or
yay -S rivetui-git

Installation (Binaries)

[!NOTE] Download the binaries from the releases

Installation (Cargo)

Dependencies

[!IMPORTANT] Make sure to have Rust installed.

Compilation from crates.io

[!IMPORTANT] Make sure that ~/.cargo/bin is in your PATH env variable.

cargo install rivetui

Compilation from source

[!NOTE] Clone the repo somewhere and compile the program.

git clone https://github.com/YetAnotherMechanicusEnjoyer/Rivet
cd Rivet/
cargo build --release

[!TIP] Either execute the binary ./target/release/rivetui or put it inside a directory included in your PATH env variable.

Initialization

[!NOTE] Either make a .env file at the root of the repository that contains the DISCORD_TOKEN variable, save it in your shell env or write it with the command.

[!TIP] Exemple of a .env file :

DISCORD_TOKEN="your-token-here"

[!TIP] Exemple of a shell env variable :

export DISCORD_TOKEN="your-token-here"

[!TIP] Exemple of a command-line env variable :

DISCORD_TOKEN="your-token-here" rivetui

Usage

rivetui

or

DISCORD_TOKEN="your-token-here" rivetui

Licence