anth64/fpk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README usage to match actual fpack/funpack CLI behavior

Browse Source
This commit is contained in:
anth64
2026-09-15 10:33:43 +02:00
parent dd669fb9b0
commit ebd3b0522f
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -2
View File
@@ -14,10 +14,21 @@ build.bat debug release tools # Windows
## Usage ## Usage
```bash ```bash
fpack output.fpk assets/ fpack [-o output.fpk] [-p] [-q] [-v] input_dir
funpack output.fpk [unpacked/] # dir defaults to "output" if omitted funpack [-d output_dir] [-l] [-p] [-q] [-v] input.fpk
``` ```
`fpack` walks `input_dir` recursively (skipping dotfiles) and writes an
archive. If `-o` is omitted, the output name is derived from the input
directory's basename plus `.fpk` (e.g. `assets/` -> `assets.fpk`).
`funpack` extracts (or, with `-l`, lists) the entries in `input.fpk`. If
`-d` is omitted, the output directory is derived from the archive's
basename with `.fpk` stripped (e.g. `assets.fpk` -> `assets/`).
Common flags: `-p` show progress, `-q` suppress the summary line, `-v`
print each entry as it's processed.
```c ```c
#include <fpk/fpk.h> #include <fpk/fpk.h>