Interspecies Reviewer

Interspecies Reviewer is a Discord bot written in Rust. The primary purpose of this bot is to automatically replace social network links with variants that fix the Discord embed issues. For example, it would changes twitter.com links to fxtwitter.com to ensure proper embed rendering.

Project Goals

The main goal of Interspecies Reviewer is to serve as a learning project for Rust. It' my first exploration into the Rust programming language.

Installation

In order to get your Token, please follow this guide from discord. https://discord.com/developers/docs/getting-started

Raw

To install Interspecies Reviewer, simply compile the source code using rustc and launch the binary generated by rustc.

Ensure you set your Discord bot token as an environment variable DISCORD_TOKEN, or directly set the token value in the code.

# Example installation steps
$ rustc main.rs
$ ./main

Docker

Alternatively, you can use Docker for installation. Pull the latest image:

docker pull ghcr.io/guilamb/interspecies_reviewer:dev-latest

Then, run the image with your Discord token:

docker run -e DISCORD_TOKEN="MySecretToken" ghcr.io/guilamb/interspecies_reviewer:dev-latest

Usage

Add the bot to your Discord server. The bot will automatically replace applicable social network links in messages. https://discord.com/developers/docs/getting-started

Configuration

The only configuration setting for Interspecies Reviewer is the Discord Token. Ensure you set it up appropriately for the bot to function correctly.
⚠️ If you inadvertently leak your token on Discord, it will be automatically invalidated.

Dependencies

Interspecies Reviewer relies on the Serenity library as its main dependency.

Contributing

Contributions to Interspecies Reviewer are welcome! If you encounter issues or have suggestions, please open an issue. Code examples and pull requests are also appreciated.

License

GPL