isledecomp/isle
1
0
Fork 0
mirror of https://github.com/isledecomp/isle.git synced 2026-01-13 03:31:15 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Update README with installation and command examples

Browse Source 
Added installation instructions for Kaitai Struct Visualizer and updated ksdump command examples.
This commit is contained in:
Christian Semmler 2026-01-10 21:44:55 +01:00 committed by GitHub
parent aeb808f12b
commit 7ad7d00aaf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@ -9,6 +9,8 @@ Kaitai Struct allows you to define binary formats in a YAML-based `.ksy` file, w
- Visualized interactively using the [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) - Visualized interactively using the [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer)
- Dumped to human-readable formats using `ksdump` - Dumped to human-readable formats using `ksdump`
<img width="1902" height="1002" alt="image" src="https://github.com/user-attachments/assets/9c34a078-40fa-44cb-81df-af073d647521" />
## Documented Formats ## Documented Formats
| File | Extension | Description | | File | Extension | Description |
@ -18,6 +20,10 @@ Kaitai Struct allows you to define binary formats in a YAML-based `.ksy` file, w
## Using the Tools ## Using the Tools
### Installation
See the [Kaitai Struct Visualizer installation instructions](https://github.com/kaitai-io/kaitai_struct_visualizer#installing) for setup details.
### Kaitai Struct Visualizer (ksv) ### Kaitai Struct Visualizer (ksv)
The [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) (`ksv`) provides an interactive terminal UI for exploring binary files. The [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) (`ksv`) provides an interactive terminal UI for exploring binary files.
@ -36,16 +42,12 @@ ksv samples/History.gsi history.ksy
```bash ```bash
# Dump Players.gsi to JSON # Dump Players.gsi to JSON
ksdump samples/Players.gsi players.ksy ksdump --format json samples/Players.gsi players.ksy
# Dump History.gsi to YAML # Dump History.gsi to YAML
ksdump --format yaml samples/History.gsi history.ksy ksdump --format yaml samples/History.gsi history.ksy
``` ```
### Installation
See the [Kaitai Struct Visualizer installation instructions](https://github.com/kaitai-io/kaitai_struct_visualizer#installing) for setup details.
## Sample Files ## Sample Files
The [`samples/`](/docs/samples/) directory contains example save files for testing: The [`samples/`](/docs/samples/) directory contains example save files for testing: