Swordfish

An open-source bot which helps you to choose best swords for fishes around the world.

Features

Faster than Leg (hopefully)
Written in Rust
Open source
... more in the future

Usage

TODO™️

Installation

Install required dependencies (Tesseract, MongoDB)

There are various way to install them, but so far on Arch Linux you would execute the following commands:
```
sudo pacman -S tesseract tesseract-data-eng
yay -S mongodb-bin
# Optional
yay -S mongodb-compass  # Manage the database with a GUI
```
Tesseract works on Linux way better than Windows, but oh well.
Clone the repository.
Set up your MongoDB database.

The free tier in MongoDB Atlas is NOT enough as it is limited to 500 entries only.

Set up the required environment variables, which contains these variables:

# Putting all of these into a .env file is fine.
DISCORD_TOKEN=<token>
MONGODB_URL=<mongodb url>
# Optional, only if the url doesn't contain a username.
MONGODB_USERNAME=<mongodb username>
# Optional, only if the url doesn't contain a password.
MONGODB_PASSWORD=<mongodb password>

Start the bot:
```
cargo run
```

FAQ

How does it work?

It'd be the same as Nori in general.

License

GNU AGPLv3

1.4 KiB Raw Blame History