BYBE - Backend

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

Download & Run (Docker)

Install from command line

docker pull ghcr.io/rakuja/bybe-backend:latest

Run

docker run -p 25566:25566 --name bybe-container bybe-backend

To run it

Download & Run (Application)

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

Features

• Browse and filter a list of all creatures.
• Browse and filter a list of all hazards.
• Balance encounters based on your party size and level (creatures + hazards).
• Generate random encounters based on your requirements (creatures + hazards).
• Support for both remaster and legacy content.
• Browse and filter a list of all items.
• Generate random shop with custom templates.
• Support for Starfinder 2e.
• Generate random npc.
• Share encounters/shops.

Requirements

Built using:

• Rust
• SQLite

Building guide - Local Development

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

4. Navigate to the project's main directory.
5. Build the project running all the tests and downloading the db (required only once):

cargo make bybe-build

6. Build the project

cargo build

6. Set DATABASE_URL variable to SQLite db path
7. Run the backend in development mode:

cargo run

8. To instead deploy the production build, run:

cargo build --release

cargo run

Building guide using Docker - Local development

1. Install Docker on your local machine
2. Clone the repository or download the ZIP

git clone https://github.com/RakuJa/BYBE

3. Go to the local BYBE project folder

4. Build docker image of bybe using

docker build -t bybe .

5. Run the image

docker run -p 25566:25566 --name bybe-container bybe

Support me

If you like this tool, consider supporting me:

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

Coding guide

1. Install prek Check out the official installation guide

cargo install --locked prek

2. Enable prek run before each commit

prek install

3. Install cargo dependencies

cargo install cargo-udeps --locked