tretrauit/swordfish
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
An open-source bot which helps you to choose best swords for fishes around the world.
63 Commits 2 Branches 0 Tags 223 KiB
Rust 100%
4f8a29230f
Go to file
tretrauit 4f8a29230f fix(katana): add [a-z0-9] to regex 
Because we defined word boundary
2024-01-13 02:52:10 +07:00
.github ci: install rust nightly 2024-01-12 18:30:27 +07:00
.vscode feat: use Arc & Mutex for LepTess 2023-12-31 22:55:32 +07:00
swordfish fix(katana): add [a-z0-9] to regex 2024-01-13 02:52:10 +07:00
swordfish-common chore(katana): move regex building to swordfish 2024-01-10 12:31:29 +07:00
swordfish-user feat(katana): implement character parsing from Calf's analysis 2024-01-10 02:09:34 +07:00
.gitignore feat: use Arc & Mutex for LepTess 2023-12-31 22:55:32 +07:00
Cargo.lock fix(katana): improve the image analyzing process 2024-01-10 01:24:22 +07:00
Cargo.toml feat: swordfish-user 2024-01-07 19:19:40 +07:00
LICENSE repo: publish 2023-12-26 23:51:22 +07:00
README.md chore: add some info to the README 2024-01-05 01:35:48 +07:00

README.md

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

  1. 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.

  2. Clone the repository.

  3. Set up your MongoDB database.

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

  4. 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>

  5. Start the bot:

    cargo run

FAQ

How does it work?

It'd be the same as Nori in general.

License

GNU AGPLv3

GNU AGPL