rom-weaver 0.19.1 → 0.20.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.
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-tools\-ppf\-undo \- Undo a PPF3 patch, using the undo data stored inside it
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver tools ppf\-undo\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-\-patch\fR> <\fB\-o\fR|\fB\-\-output\fR>
|
|
7
|
+
\fBrom\-weaver tools ppf\-undo\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-target\fR] [\fB\-\-no\-progress\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-log\-level\fR] [\fB\-\-patch\-select\fR] [\fB\-\-no\-extract\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-no\-ignore\fR] [\fB\-\-no\-compress\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-compress\-format\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-compress\-codec\fR] [\fB\-\-compress\-level\fR] [\fB\-\-no\-color\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-\-patch\fR> <\fB\-o\fR|\fB\-\-output\fR>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Undo a PPF3 patch, turning a patched ROM back into the original.
|
|
10
10
|
.PP
|
|
@@ -13,16 +13,127 @@ PPF3 format. Without it there is nothing to reverse from.
|
|
|
13
13
|
.SH OPTIONS
|
|
14
14
|
.TP
|
|
15
15
|
\fB\-i\fR, \fB\-\-input\fR \fI<ROM>\fR
|
|
16
|
-
The already\-patched ROM to undo
|
|
16
|
+
The already\-patched ROM to undo. May be an archive
|
|
17
17
|
.TP
|
|
18
18
|
\fB\-\-patch\fR \fI<PPF>\fR
|
|
19
|
-
The PPF3 patch that was applied.
|
|
19
|
+
The PPF3 patch that was applied. Must carry undo data; may be an archive
|
|
20
20
|
.TP
|
|
21
21
|
\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
|
|
22
22
|
Output path; \- writes one completed binary file to stdout
|
|
23
23
|
.TP
|
|
24
|
+
\fB\-\-target\fR \fI<GLOB>\fR
|
|
25
|
+
Disc track to restore, by exact name or glob. Required for a disc with multiple tracks
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
|
|
28
|
+
Pick the ROM archive payload by name, prefix, or glob (repeatable)
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-patch\-select\fR \fI<PATCH_SELECT>\fR
|
|
31
|
+
Pick the PPF archive payload by name, prefix, or glob (repeatable)
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-no\-extract\fR
|
|
34
|
+
Treat the ROM and patch as raw files instead of extracting archives
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-no\-ignore\fR
|
|
37
|
+
Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
|
|
40
|
+
How many threads to use at most. auto uses every core; a format may still use fewer
|
|
41
|
+
.TP
|
|
24
42
|
\fB\-h\fR, \fB\-\-help\fR
|
|
25
43
|
Print help (see a summary with \*(Aq\-h\*(Aq)
|
|
44
|
+
.SH BASIC
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-no\-compress\fR
|
|
47
|
+
Write a plain ROM instead of compressing the result
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-compress\-format\fR \fI<COMPRESS_FORMAT>\fR
|
|
50
|
+
Format to compress the restored ROM into, such as zip, 7z, chd, rvz, or z3ds.
|
|
51
|
+
|
|
52
|
+
Normally you do not need this: the format comes from the \-\-output extension.
|
|
53
|
+
Pass it when the output name has no usable extension. If it disagrees with the
|
|
54
|
+
extension, this flag wins and a warning is printed. Use \-\-no\-compress to write
|
|
55
|
+
a plain ROM instead.
|
|
56
|
+
.br
|
|
57
|
+
|
|
58
|
+
.br
|
|
59
|
+
\fIPossible values:\fR
|
|
60
|
+
.RS 14
|
|
61
|
+
.IP \(bu 2
|
|
62
|
+
zip
|
|
63
|
+
.IP \(bu 2
|
|
64
|
+
7z
|
|
65
|
+
.IP \(bu 2
|
|
66
|
+
chd
|
|
67
|
+
.IP \(bu 2
|
|
68
|
+
rvz
|
|
69
|
+
.IP \(bu 2
|
|
70
|
+
z3ds
|
|
71
|
+
.RE
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-compress\-codec\fR \fI<COMPRESS_CODEC>\fR
|
|
74
|
+
Compression method for the restored ROM, written as codec or codec:level.
|
|
75
|
+
|
|
76
|
+
Each format has its own codecs, and each picks a sensible one on its own, so
|
|
77
|
+
this is only for overriding that choice. CHD takes a list, tried in order:
|
|
78
|
+
|
|
79
|
+
\-\-compress\-codec cdzs:19,cdzl,cdfl
|
|
80
|
+
|
|
81
|
+
Without :level, a codec follows the \-\-compress\-level profile.
|
|
82
|
+
.br
|
|
83
|
+
|
|
84
|
+
.br
|
|
85
|
+
\fIPossible values:\fR
|
|
86
|
+
.RS 14
|
|
87
|
+
.IP \(bu 2
|
|
88
|
+
store
|
|
89
|
+
.IP \(bu 2
|
|
90
|
+
deflate
|
|
91
|
+
.IP \(bu 2
|
|
92
|
+
zstd
|
|
93
|
+
.IP \(bu 2
|
|
94
|
+
lzma
|
|
95
|
+
.IP \(bu 2
|
|
96
|
+
lzma2
|
|
97
|
+
.IP \(bu 2
|
|
98
|
+
zlib
|
|
99
|
+
.IP \(bu 2
|
|
100
|
+
huff
|
|
101
|
+
.IP \(bu 2
|
|
102
|
+
flac
|
|
103
|
+
.IP \(bu 2
|
|
104
|
+
cdzs
|
|
105
|
+
.IP \(bu 2
|
|
106
|
+
cdlz
|
|
107
|
+
.IP \(bu 2
|
|
108
|
+
cdzl
|
|
109
|
+
.IP \(bu 2
|
|
110
|
+
cdfl
|
|
111
|
+
.IP \(bu 2
|
|
112
|
+
avhuff
|
|
113
|
+
.RE
|
|
114
|
+
.TP
|
|
115
|
+
\fB\-\-compress\-level\fR \fI<COMPRESS_LEVEL>\fR
|
|
116
|
+
How hard to compress: min, very\-low, low, medium, high, very\-high, or max [default: max]
|
|
117
|
+
.br
|
|
118
|
+
|
|
119
|
+
.br
|
|
120
|
+
\fIPossible values:\fR
|
|
121
|
+
.RS 14
|
|
122
|
+
.IP \(bu 2
|
|
123
|
+
min
|
|
124
|
+
.IP \(bu 2
|
|
125
|
+
very\-low
|
|
126
|
+
.IP \(bu 2
|
|
127
|
+
low
|
|
128
|
+
.IP \(bu 2
|
|
129
|
+
medium
|
|
130
|
+
.IP \(bu 2
|
|
131
|
+
high
|
|
132
|
+
.IP \(bu 2
|
|
133
|
+
very\-high
|
|
134
|
+
.IP \(bu 2
|
|
135
|
+
max
|
|
136
|
+
.RE
|
|
26
137
|
.SH "GLOBAL OPTIONS"
|
|
27
138
|
.TP
|
|
28
139
|
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
@@ -10,7 +10,8 @@ Cut the unused padding off the end of a ROM, making the file smaller without
|
|
|
10
10
|
changing what a console or emulator reads from it.
|
|
11
11
|
.PP
|
|
12
12
|
Works on NDS\-family ROMs (.nds, .dsi, .srl), GBA (.gba), 3DS (.3ds), XISO
|
|
13
|
-
images, and RVZ
|
|
13
|
+
images, and GameCube/Wii discs. Disc inputs convert losslessly to RVZ; unused
|
|
14
|
+
sectors are preserved, and the size reduction comes from compression.
|
|
14
15
|
.PP
|
|
15
16
|
By default a new file is written. \-\-in\-place overwrites the original, and
|
|
16
17
|
\-n/\-\-dry\-run reports what would change without touching anything.
|
|
@@ -41,13 +42,13 @@ padding byte. Without a footer, the size rounds up to the next power of two;
|
|
|
41
42
|
NDS also keeps the used\-data boundary from its header. Restoration does not
|
|
42
43
|
guarantee the original bytes.
|
|
43
44
|
|
|
44
|
-
XISO and RVZ
|
|
45
|
+
XISO trimming and lossless RVZ conversion do not support this operation.
|
|
45
46
|
.TP
|
|
46
47
|
\fB\-\-no\-recursive\fR
|
|
47
48
|
When an input is a folder, look only at its top level
|
|
48
49
|
.TP
|
|
49
50
|
\fB\-\-filter\fR \fI<FILTER>\fR [default: rom]
|
|
50
|
-
|
|
51
|
+
Filter archive members by kind (default: rom); patch\-only filters are not supported
|
|
51
52
|
.br
|
|
52
53
|
|
|
53
54
|
.br
|
|
@@ -66,7 +67,7 @@ Consider every file inside an archive, not just the ones that look like ROMs
|
|
|
66
67
|
Do not look inside archives; trim only the files named directly
|
|
67
68
|
.TP
|
|
68
69
|
\fB\-\-revert\-marker\fR
|
|
69
|
-
Add a footer with the original size and a fill byte for \-\-revert
|
|
70
|
+
Add a footer with the original size and a fill byte for \-\-revert (NDS\-family, GBA, and 3DS only)
|
|
70
71
|
.TP
|
|
71
72
|
\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
|
|
72
73
|
How many threads to use at most. auto uses every core; a format may still use fewer
|
package/docs/man/rom-weaver.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver 1 "rom-weaver 0.
|
|
3
|
+
.TH rom-weaver 1 "rom-weaver 0.20.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver \- Inspect, extract, checksum, compress, trim, and patch ROMs and disc images
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -148,4 +148,4 @@ Examples:
|
|
|
148
148
|
|
|
149
149
|
Full guide: https://rom\-weaver.com/docs/cli
|
|
150
150
|
.SH VERSION
|
|
151
|
-
v0.
|
|
151
|
+
v0.20.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rom-weaver",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0",
|
|
4
4
|
"description": "Convenience alias for @rom-weaver/cli, the canonical package. Installs the CLI under the unscoped name so `npx rom-weaver` works.",
|
|
5
5
|
"author": "Brandon Casey",
|
|
6
6
|
"license": "AGPL-3.0-or-later",
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
"docs/man/rom-weaver-weave.1"
|
|
73
73
|
],
|
|
74
74
|
"dependencies": {
|
|
75
|
-
"@rom-weaver/cli": "0.
|
|
75
|
+
"@rom-weaver/cli": "0.20.0"
|
|
76
76
|
},
|
|
77
77
|
"files": [
|
|
78
78
|
"bin/rom-weaver.mjs",
|