bdmv2web 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,48 @@
1
- # Temporary Holding Version
1
+ # bdmv2web
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Turn a Blu-ray BDMV directory into an offline browser menu, while keeping the original M2TS video playable through the system player.
4
+
5
+ This is the published CLI package. Full documentation: <https://github.com/tautcony/bdmv2web>.
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ npm install -g bdmv2web
11
+ bdmv2web --version
12
+ ```
13
+
14
+ Requires Node.js `>=22`. `ffmpeg` and `ffprobe` must be callable from `PATH` for media work: `ffmpeg` needs `libx265`, `libx264`, and `aac`, and HDR tone mapping additionally needs `zscale` (libzimg) or `libplacebo`.
15
+
16
+ ## Quick start
17
+
18
+ ```sh
19
+ bdmv2web build /path/to/BDMV --out ./BDMV-menu
20
+ ```
21
+
22
+ Open `BDMV-menu/index.html` in a browser. Keep the whole output directory when copying or moving the menu.
23
+
24
+ ```sh
25
+ bdmv2web validate ./BDMV-menu --offline
26
+ ```
27
+
28
+ ## Commands
29
+
30
+ `<BDMV>` may point to a BDMV directory or to a parent directory that contains `BDMV/`.
31
+
32
+ | Command | Purpose |
33
+ | --- | --- |
34
+ | `inspect <BDMV>` | Show disc structure and diagnostics (`--format table\|json`, `--out FILE`, `--strict`) |
35
+ | `extract <BDMV> --out DIR` | Export HDMV, IGS, and SUP analysis data (`--type hdmv\|igs\|sup`, `--all`) |
36
+ | `list <BDMV>` | List exportable IGS and SUP assets (`--type`, `--m2ts CLIP_ID`, `--pid PID`) |
37
+ | `export <BDMV> --out DIR` | Export raw `.mnu` and `.sup` assets (`--type`, `--m2ts`, `--pid`, `--decode png`) |
38
+ | `render <input>` | Render PNG from a BDMV, `.mnu`, or `.sup` (`--out DIR`, `--type`, `--language LANG`) |
39
+ | `build <BDMV>` | Build the offline menu package (`--out DIR`, `--title NAME`, `--player-profile FILE`, `--codec hevc\|h264`, `--crf N`, `--preset NAME`, `--hdr tonemap\|preserve`, `--overwrite`, `--strict`) |
40
+ | `validate <menu dir> --offline` | Validate a menu package and update the audit report (`--format json`, `--strict`) |
41
+
42
+ `convert` is an alias of `build`. `bdmv2web --help` lists every command and `bdmv2web <command> --help` lists the options of one command.
43
+
44
+ The exit code is 0 on success and 1 on failure; with `--strict`, a partially completed result exits with 2.
45
+
46
+ ## License
47
+
48
+ [GNU GPL v3](https://github.com/tautcony/bdmv2web/blob/master/LICENSE).