Mirror/Erupe
1
0
Fork 0
mirror of https://github.com/Mezeporta/Erupe.git synced 2026-03-21 23:22:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: document JSON format support in README and CHANGELOG

Browse Source 
Add a JSON Format Support section to the README covering quests,
scenarios, and Hunting Road config. Add two missing CHANGELOG entries
for the rengoku .bin-first fix and the quest event board JSON fallback.
This commit is contained in:
Houmgaor
2026-03-20 16:41:36 +01:00
parent 73904965ff
commit fec2793ccc
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- Fixed backup recovery panic: `recoverFromBackups` now rejects decompressed backup data smaller than the minimum save layout size, preventing a slice-bounds panic when nullcomp passes through garbage bytes as "already decompressed" data ([#182](https://github.com/Mezeporta/Erupe/pull/182)).
- Fixed `rengoku_data.json` taking priority over `rengoku_data.bin` — all three loaders (quests, scenarios, Hunting Road) now consistently prefer `.bin` first with `.json` as fallback.
- Fixed JSON-authored quests not appearing on the event quest board — `loadQuestFile` now falls back to `.json` when no `.bin` is present, matching the behaviour of the file-serve path.
## [9.3.0] - 2026-03-19

12
README.md
View File

@@ -69,6 +69,18 @@ These files contain quest definitions and scenario data that the server sends to
**Without these files, quests will not load and the client will crash.**
### JSON Format Support
As an alternative to opaque `.bin` files, Erupe supports human-readable `.json` files for quests, scenarios, and Hunting Road config. The server always tries `.bin` first and falls back to `.json` automatically — existing binary files work unchanged.
| File type | Location | Documentation |
|-----------|----------|---------------|
| Quest | `bin/quests/<name>.json` | Erupe wiki |
| Scenario | `bin/scenarios/<name>.json` | `docs/scenario-format.md` |
| Hunting Road | `bin/rengoku_data.json` | Erupe wiki |
JSON quests and scenarios use UTF-8 text (converted to Shift-JIS on the wire), making them diff-friendly and editable without binary tools.
## Client Setup
1. Obtain a Monster Hunter Frontier client (version G10 or later recommended)