2024-06-30 22:47:28 +03:00
|
|
|
# KHGuide
|
|
|
|
|
|
2025-01-31 22:56:28 +02:00
|
|
|
A small static page generator for guides on a bunch of Kingdom Hearts features.
|
|
|
|
|
|
|
|
|
|
Such as:
|
|
|
|
|
|
2025-07-05 10:58:11 +03:00
|
|
|
- synthesis lists and trackers
|
|
|
|
|
- enemy drops and location
|
2025-01-31 22:56:28 +02:00
|
|
|
- command melding for Birth By Sleep
|
|
|
|
|
- spirit boards for Dream Drop Distance
|
2025-10-31 22:23:30 +02:00
|
|
|
- food and pro codes simulators for Kingdom Hearts 3
|
2024-06-30 22:47:28 +03:00
|
|
|
|
2025-07-05 10:58:11 +03:00
|
|
|
## Usage
|
2024-06-30 22:47:28 +03:00
|
|
|
|
2025-07-05 10:58:11 +03:00
|
|
|
- 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)
|
2025-10-31 22:23:30 +02:00
|
|
|
- A locally running web server that can serve files, such as [caddy](https://github.com/caddyserver/caddy)
|
2025-07-05 10:58:11 +03:00
|
|
|
|
|
|
|
|
### Setup
|
|
|
|
|
|
|
|
|
|
1. Clone the repo locally using git
|
|
|
|
|
2. Setup your web server and make sure it runs
|
2025-10-31 22:23:30 +02:00
|
|
|
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`
|
