Skip to content

MRDGH2821/Coco-Bot

Repository files navigation

Coco-Bot

Rust port of KittyBot for the CS@unimelb Discord server.

Getting started

Some common steps before you start the bot.

  1. Install Rust or Docker Engine depending on what method you prefer.
  2. Make a copy of sample.env & fill in the variables. Rename it to .env
  3. Follow any one method.

Docker method (Recommended)

  1. Download docker compose file
  2. Follow the common step no. 2
  3. Run in terminal:
docker compose up -d

Use installer script (Easy)

Download and run the installer script that automatically detects your platform:

curl -fsSL https://raw.githubusercontent.com/MRDGH2821/Coco-Bot/main/coco-installer.sh | sh

Then follow Use precompiled binaries Step 3 onwards

Use precompiled binaries

  1. Head over to Releases
  2. Download the archive as per your os & architecture.
  3. Follow the common step no. 2
  4. Double click to execute or:

In linux terminal:

./coco-bot.bin

In Windows terminal

./coco-bot.exe

Compile from source

  1. Clone this repo:
git clone https://github.com/MRDGH2821/Coco-Bot/
  1. Follow the common step no. 2
  2. Run in terminal:
cargo run

Licence

Source Code is licenced under Apache 2.0.

Impact font was used from DeeFont.

Images in src/assets/meme_templates are assumed to be in public domain.

About

Rust port of [KittyBot](https://github.com/olliequ/KittyBot) for the CS@unimelb Discord server.

Topics

Resources

License

Stars

Watchers

Forks

Packages