[go: up one dir, main page]

Skip to content

RakuJa/BYBE

Repository files navigation

Rust Actix-web SQLite License: MIT Built with cargo-make

BYBE - Backend

Beyond Your Bestiary Explorer (BYBE) provides tools to help Pathfinder 2e Game Masters. Built as the backend of BYBE - Frontend

Features

  • Browse and filter a list of all creatures.
  • Balance encounters based on your party size and level.
  • Generate random encounters based on your requirements.
  • Support for both remaster and legacy content.
  • Browse and filter a list of all items.
  • Generate random shop with custom templates.
  • More to come...

Requirements

Built using:

Installation guide - Local

  1. Install Rust on your machine.
  2. Populate the SQLite database (public release date TBA).
  3. Clone this repository:
git clone https://github.com/RakuJa/BYBE
  1. Navigate to the project's main directory.
  2. Build the project running all the tests and downloading the db (required only once):
cargo make bybe-build
  1. Build the project
cargo build
  1. Set DATABASE_URL variable to SQLite db path
  2. Run the backend in development mode:
cargo run
  1. To instead deploy the production build, run:
cargo build --release
cargo run

Installation guide using Docker

  1. Install Docker on your local machine
  2. Clone the repository or download the ZIP
git clone https://github.com/RakuJa/BYBE
  1. Go to the local BYBE project folder

  2. Build docker image of bybe using

docker build -t bybe .
  1. Run the image
docker run -p 25566:25566 --name bybe-container bybe

Support me

If you like this tool, consider supporting me:

ko-fi

Also consider supporting TheAsel, the frontend developer. Thank you!

BYBE-Portable

If you were looking for the BYBE Local Application, it can be found Here