# KHGuide

A small static page generator for guides on a bunch of Kingdom Hearts features.

Such as:

- synthesis lists and trackers
- enemy drops and location
- command melding for Birth By Sleep
- spirit boards for Dream Drop Distance
- food and pro codes simulators for Kingdom Hearts 3

## Usage

- Probably the easiest way is to use the hosted version offered [here](https://git.pixelatedw.xyz/pages/wynd/khguide/)
- For a local version you'll need a web server to serve CSS and JavaScript modules, read the below Development section for this

## Development

### Prerequisite:

- git
- [Rust 1.85](https://www.rust-lang.org/tools/install)
- [Just](https://github.com/casey/just?tab=readme-ov-file#installation)
- A locally running web server that can serve files, such as [caddy](https://github.com/caddyserver/caddy)

### Setup

1. Clone the repo locally using git
2. Setup your web server and make sure it runs
3. Configure the web server so it serves files
   - Caddy: [`file_server`](https://caddyserver.com/docs/caddyfile/directives/file_server)
4. Use `just` or `just build` this will generate all the HTML files
5. Copy all assets from the newly generated `out` folder inside caddy's `site` folder to be served
   - Make sure the path served is the same as the `BASE_URL` env var (ex: `site/khguide` corresponds to `BASE_URL="/khguide"`)
6. Access the app at `localhost`
