rom-weaver 0.20.0 → 0.21.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/docs/man/rom-weaver-bundle-create.1 +26 -26
- package/docs/man/rom-weaver-bundle-parse.1 +11 -11
- package/docs/man/rom-weaver-bundle-schema.1 +8 -8
- package/docs/man/rom-weaver-bundle.1 +10 -10
- package/docs/man/rom-weaver-cheat.1 +1 -1
- package/docs/man/rom-weaver-patch-apply.1 +15 -15
- package/docs/man/rom-weaver-patch-create.1 +1 -1
- package/docs/man/rom-weaver-patch-validate.1 +1 -1
- package/docs/man/rom-weaver-setup.1 +7 -5
- package/docs/man/rom-weaver-weave-create.1 +332 -0
- package/docs/man/rom-weaver-weave-parse.1 +110 -0
- package/docs/man/rom-weaver-weave-schema.1 +79 -0
- package/docs/man/rom-weaver-weave.1 +14 -402
- package/docs/man/rom-weaver.1 +5 -8
- package/package.json +6 -3
|
@@ -2,410 +2,15 @@
|
|
|
2
2
|
.el .ds Aq '
|
|
3
3
|
.TH rom-weaver-weave 1 "rom-weaver-weave "
|
|
4
4
|
.SH NAME
|
|
5
|
-
rom\-weaver\-weave \-
|
|
5
|
+
rom\-weaver\-weave \- Build and read rom\-weaver\-weave.json patch recipes
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver weave\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB
|
|
7
|
+
\fBrom\-weaver weave\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] <\fIsubcommands\fR>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
|
-
|
|
10
|
-
.PP
|
|
11
|
-
Use `rom\-weaver patch apply` for the canonical command. The compatibility
|
|
12
|
-
spelling `rom\-weaver weave` runs the same command.
|
|
13
|
-
.PP
|
|
14
|
-
Repeat \-\-patch once per patch. They run left to right, each one on the result
|
|
15
|
-
of the last. \-\-input takes a plain ROM, an archive, or a single\-payload
|
|
16
|
-
compressed format (the ROM inside is found for you), or a
|
|
17
|
-
rom\-weaver\-bundle.json that already names the ROM, the patches, and the
|
|
18
|
-
output.
|
|
19
|
-
.PP
|
|
20
|
-
When \-\-output names the selected ROM leaf\*(Aqs extension, rom\-weaver writes a
|
|
21
|
-
plain ROM. A registered container extension such as .zip compresses the result.
|
|
22
|
-
Pass \-\-no\-compress (or \-\-raw) to force a plain ROM, or use \-\-compress\-format,
|
|
23
|
-
\-\-compress\-codec, and \-\-compress\-level (also accepted as \-\-format, \-\-codec,
|
|
24
|
-
and \-\-level) to force compression. Without \-\-output, an ordinary file apply
|
|
25
|
-
writes a collision\-safe sibling named <stem>\-patched.<ext>.
|
|
26
|
-
.PP
|
|
27
|
-
Patch formats: IPS, IPS32, SOLID, BPS, UPS, VCDIFF, xdelta, GDIFF,
|
|
28
|
-
HDiffPatch/HPatchZ, APS (N64), APSGBA, RUP, PPF, PAT/FFP, EBP, BDF/BSDIFF40,
|
|
29
|
-
BSP, MOD/PMSR, DLDI, DPS, and DCP (Dreamcast).
|
|
30
|
-
.PP
|
|
31
|
-
Not supported: PDS; NINJA1 (recognized, but cannot be applied); HDiffPatch
|
|
32
|
-
directory patches, HDIFF19 (single\-file .hdiff and .hpatchz are fine).
|
|
33
|
-
.PP
|
|
34
|
-
DCP needs a Dreamcast .cue or .gdi input. It rebuilds the whole disc, so it
|
|
35
|
-
cannot be combined with other patches or with the header and checksum options.
|
|
9
|
+
Build and read rom\-weaver\-weave.json patch recipes
|
|
36
10
|
.SH OPTIONS
|
|
37
11
|
.TP
|
|
38
|
-
\fB\-\-force\fR
|
|
39
|
-
Overwrite the output if it already exists (without this, the command stops instead)
|
|
40
|
-
.TP
|
|
41
12
|
\fB\-h\fR, \fB\-\-help\fR
|
|
42
|
-
Print help
|
|
43
|
-
.SH BASIC
|
|
44
|
-
.TP
|
|
45
|
-
\fB\-i\fR, \fB\-\-input\fR \fI<PATH>\fR
|
|
46
|
-
ROM to patch. May be an archive, a disc sheet (.cue/.gdi), or a bundle
|
|
47
|
-
.TP
|
|
48
|
-
\fB\-\-patch\fR \fI<PATCHES>\fR
|
|
49
|
-
Patch to apply. Repeat once per patch; they run in the order given, each on the
|
|
50
|
-
result of the last.
|
|
51
|
-
|
|
52
|
-
Leave it out and rom\-weaver looks for RetroArch\-style patches sitting next to
|
|
53
|
-
the ROM inside the input archive.
|
|
54
|
-
.TP
|
|
55
|
-
\fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
|
|
56
|
-
Output path; \- writes one completed binary file to stdout
|
|
57
|
-
.TP
|
|
58
|
-
\fB\-\-no\-compress\fR
|
|
59
|
-
Write a plain ROM instead of compressing the result
|
|
60
|
-
.TP
|
|
61
|
-
\fB\-\-compress\-format\fR \fI<COMPRESS_FORMAT>\fR
|
|
62
|
-
Format to compress the patched ROM into, such as zip, 7z, chd, rvz, or z3ds.
|
|
63
|
-
|
|
64
|
-
Normally you do not need this: the format comes from the \-\-output extension.
|
|
65
|
-
Pass it when the output name has no usable extension. If it disagrees with the
|
|
66
|
-
extension, this flag wins and a warning is printed. Use \-\-no\-compress to write
|
|
67
|
-
a plain ROM instead.
|
|
68
|
-
.br
|
|
69
|
-
|
|
70
|
-
.br
|
|
71
|
-
\fIPossible values:\fR
|
|
72
|
-
.RS 14
|
|
73
|
-
.IP \(bu 2
|
|
74
|
-
zip
|
|
75
|
-
.IP \(bu 2
|
|
76
|
-
7z
|
|
77
|
-
.IP \(bu 2
|
|
78
|
-
chd
|
|
79
|
-
.IP \(bu 2
|
|
80
|
-
rvz
|
|
81
|
-
.IP \(bu 2
|
|
82
|
-
z3ds
|
|
83
|
-
.RE
|
|
84
|
-
.TP
|
|
85
|
-
\fB\-\-compress\-codec\fR \fI<COMPRESS_CODEC>\fR
|
|
86
|
-
Compression method for the patched ROM, written as codec or codec:level.
|
|
87
|
-
|
|
88
|
-
Each format has its own codecs, and each picks a sensible one on its own, so
|
|
89
|
-
this is only for overriding that choice. CHD takes a list, tried in order:
|
|
90
|
-
|
|
91
|
-
\-\-compress\-codec cdzs:19,cdzl,cdfl
|
|
92
|
-
|
|
93
|
-
Without :level, a codec follows the \-\-compress\-level profile.
|
|
94
|
-
.br
|
|
95
|
-
|
|
96
|
-
.br
|
|
97
|
-
\fIPossible values:\fR
|
|
98
|
-
.RS 14
|
|
99
|
-
.IP \(bu 2
|
|
100
|
-
store
|
|
101
|
-
.IP \(bu 2
|
|
102
|
-
deflate
|
|
103
|
-
.IP \(bu 2
|
|
104
|
-
zstd
|
|
105
|
-
.IP \(bu 2
|
|
106
|
-
lzma
|
|
107
|
-
.IP \(bu 2
|
|
108
|
-
lzma2
|
|
109
|
-
.IP \(bu 2
|
|
110
|
-
zlib
|
|
111
|
-
.IP \(bu 2
|
|
112
|
-
huff
|
|
113
|
-
.IP \(bu 2
|
|
114
|
-
flac
|
|
115
|
-
.IP \(bu 2
|
|
116
|
-
cdzs
|
|
117
|
-
.IP \(bu 2
|
|
118
|
-
cdlz
|
|
119
|
-
.IP \(bu 2
|
|
120
|
-
cdzl
|
|
121
|
-
.IP \(bu 2
|
|
122
|
-
cdfl
|
|
123
|
-
.IP \(bu 2
|
|
124
|
-
avhuff
|
|
125
|
-
.RE
|
|
126
|
-
.TP
|
|
127
|
-
\fB\-\-compress\-level\fR \fI<COMPRESS_LEVEL>\fR
|
|
128
|
-
How hard to compress: min, very\-low, low, medium, high, very\-high, or max [default: max]
|
|
129
|
-
.br
|
|
130
|
-
|
|
131
|
-
.br
|
|
132
|
-
\fIPossible values:\fR
|
|
133
|
-
.RS 14
|
|
134
|
-
.IP \(bu 2
|
|
135
|
-
min
|
|
136
|
-
.IP \(bu 2
|
|
137
|
-
very\-low
|
|
138
|
-
.IP \(bu 2
|
|
139
|
-
low
|
|
140
|
-
.IP \(bu 2
|
|
141
|
-
medium
|
|
142
|
-
.IP \(bu 2
|
|
143
|
-
high
|
|
144
|
-
.IP \(bu 2
|
|
145
|
-
very\-high
|
|
146
|
-
.IP \(bu 2
|
|
147
|
-
max
|
|
148
|
-
.RE
|
|
149
|
-
.SH ARCHIVE/BUNDLE
|
|
150
|
-
.TP
|
|
151
|
-
\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
|
|
152
|
-
Pick which file to use when the ROM or a patch is inside an archive, by exact name, prefix, or glob (repeatable). \-\-patch\-select overrides it for the patch it follows
|
|
153
|
-
.TP
|
|
154
|
-
\fB\-\-target\fR \fI<TARGET>\fR
|
|
155
|
-
For a .cue or .gdi input, which track gets the patch. Matched like \-\-select and must hit exactly one track
|
|
156
|
-
.TP
|
|
157
|
-
\fB\-\-filter\fR \fI<FILTER>\fR
|
|
158
|
-
Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
|
|
159
|
-
.br
|
|
160
|
-
|
|
161
|
-
.br
|
|
162
|
-
\fIPossible values:\fR
|
|
163
|
-
.RS 14
|
|
164
|
-
.IP \(bu 2
|
|
165
|
-
rom
|
|
166
|
-
.IP \(bu 2
|
|
167
|
-
patch
|
|
168
|
-
.RE
|
|
169
|
-
.TP
|
|
170
|
-
\fB\-\-no\-extract\fR
|
|
171
|
-
Do not look inside archives; treat the input and every patch as raw files
|
|
172
|
-
.TP
|
|
173
|
-
\fB\-\-no\-ignore\fR
|
|
174
|
-
Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
|
|
175
|
-
.TP
|
|
176
|
-
\fB\-\-patch\-select\fR \fI<GLOB>\fR
|
|
177
|
-
Pick which file to use inside the \-\-patch archive before it. Repeatable, one per \-\-patch; falls back to \-\-select
|
|
178
|
-
.TP
|
|
179
|
-
\fB\-\-bundle\fR \fI<BUNDLE>\fR
|
|
180
|
-
Follow a rom\-weaver\-bundle.json recipe, which lists the patches, their order,
|
|
181
|
-
and the expected checksums. Takes a file path or an http(s) URL.
|
|
182
|
-
|
|
183
|
-
You can usually skip this flag. A bundle is picked up automatically when
|
|
184
|
-
\-\-input is a rom\-weaver\-bundle.json (optionally .gz, .bz2, .xz, or .zst), or an
|
|
185
|
-
archive with one at its root, and you passed no \-\-patch of your own.
|
|
186
|
-
.TP
|
|
187
|
-
\fB\-\-with\fR \fI<GLOB>\fR
|
|
188
|
-
Turn on a bundle patch the bundle leaves off by default, matched by name or file name (repeatable)
|
|
189
|
-
.TP
|
|
190
|
-
\fB\-\-without\fR \fI<GLOB>\fR
|
|
191
|
-
Turn off a bundle patch, matched by name or file name (repeatable)
|
|
192
|
-
.TP
|
|
193
|
-
\fB\-\-without\-cheats\fR
|
|
194
|
-
Ignore every cheat the bundle records and run only its patch chain
|
|
195
|
-
.SH COMPATIBILITY
|
|
196
|
-
.TP
|
|
197
|
-
\fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
|
|
198
|
-
Take this checksum on trust instead of reading the ROM to compute it, as in
|
|
199
|
-
crc32=1234abcd. Repeatable and comma\-separable.
|
|
200
|
-
|
|
201
|
-
This is a speed option for scripts that already know the checksum: it skips a
|
|
202
|
-
full read of a large ROM. It does not verify anything. To check a ROM against a
|
|
203
|
-
checksum, use \-\-expect\-in.
|
|
204
|
-
.TP
|
|
205
|
-
\fB\-\-expect\-in\fR \fI<ALGO=HEX>\fR
|
|
206
|
-
Stop unless the ROM about to be patched has this checksum, as in
|
|
207
|
-
crc32=1234abcd. Repeatable and comma\-separable.
|
|
208
|
-
|
|
209
|
-
Use it when a patch\*(Aqs readme publishes a source checksum, to be sure you are
|
|
210
|
-
starting from the ROM the author used. The size gates size=N and min\-size=N
|
|
211
|
-
work on `patch validate` only.
|
|
212
|
-
.TP
|
|
213
|
-
\fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
|
|
214
|
-
Whether a patch applies to the ROM with or without its copier header.
|
|
215
|
-
|
|
216
|
-
Some ROMs carry a small header added by old copier hardware, and a patch may
|
|
217
|
-
have been made either with it or without it. Getting this wrong makes the patch
|
|
218
|
-
fail or produce a broken ROM.
|
|
219
|
-
|
|
220
|
-
auto Work it out per patch (the default). A patch carrying its own source
|
|
221
|
-
checksum (BPS, UPS, RUP) settles it outright. A patch without one
|
|
222
|
-
(IPS) is judged on where its records land, and if that is still
|
|
223
|
-
unclear by applying it both ways and keeping the result the console
|
|
224
|
-
still recognises as its own ROM. Any remaining doubt leaves the
|
|
225
|
-
bytes alone.
|
|
226
|
-
keep Apply to the bytes as they are.
|
|
227
|
-
strip Remove the header first.
|
|
228
|
-
|
|
229
|
-
Repeatable, and each occurrence binds to the \-\-patch before it and carries
|
|
230
|
-
forward until the next one:
|
|
231
|
-
|
|
232
|
-
\-\-patch a.bps \-\-patch\-header strip \-\-patch b.ups strips for both
|
|
233
|
-
\-\-patch a.bps \-\-patch b.ups \-\-patch\-header strip strips for b.ups only
|
|
234
|
-
|
|
235
|
-
An occurrence before any \-\-patch applies to every patch.
|
|
236
|
-
|
|
237
|
-
Headers detected: A78, LNX, NES, FDS, and SMC signatures, plus the SNES and PCE
|
|
238
|
-
copier size rules.
|
|
239
|
-
.br
|
|
240
|
-
|
|
241
|
-
.br
|
|
242
|
-
\fIPossible values:\fR
|
|
243
|
-
.RS 14
|
|
244
|
-
.IP \(bu 2
|
|
245
|
-
keep
|
|
246
|
-
.IP \(bu 2
|
|
247
|
-
strip
|
|
248
|
-
.IP \(bu 2
|
|
249
|
-
auto
|
|
250
|
-
.RE
|
|
251
|
-
.TP
|
|
252
|
-
\fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
|
|
253
|
-
Which ROM the preceding \-\-patch was built against, and so which one its
|
|
254
|
-
checksums describe.
|
|
255
|
-
|
|
256
|
-
auto Clear the shared rule and work it out from the checksums.
|
|
257
|
-
base The original ROM. It is verified once up front, and the patch\*(Aqs own
|
|
258
|
-
checks are skipped when it runs later in the chain.
|
|
259
|
-
previous The output of the patch before it.
|
|
260
|
-
|
|
261
|
-
Reach for this when several patches in a chain were each written against the
|
|
262
|
-
unmodified ROM rather than against each other.
|
|
263
|
-
|
|
264
|
-
This flag must follow the \-\-patch it describes and applies only to that patch.
|
|
265
|
-
Use \-\-default\-patch\-basis to set one rule for every patch.
|
|
266
|
-
.br
|
|
267
|
-
|
|
268
|
-
.br
|
|
269
|
-
\fIPossible values:\fR
|
|
270
|
-
.RS 14
|
|
271
|
-
.IP \(bu 2
|
|
272
|
-
auto
|
|
273
|
-
.IP \(bu 2
|
|
274
|
-
base
|
|
275
|
-
.IP \(bu 2
|
|
276
|
-
previous
|
|
277
|
-
.RE
|
|
278
|
-
.TP
|
|
279
|
-
\fB\-\-default\-patch\-basis\fR \fI<DEFAULT_PATCH_BASIS>\fR
|
|
280
|
-
Set one input ROM rule for every patch. An individual \-\-patch\-basis can override it.
|
|
281
|
-
|
|
282
|
-
base Every patch was made from the original ROM.
|
|
283
|
-
previous Each later patch was made from the previous result.
|
|
284
|
-
auto Infer the input ROM from checksums (the default).
|
|
285
|
-
.br
|
|
286
|
-
|
|
287
|
-
.br
|
|
288
|
-
\fIPossible values:\fR
|
|
289
|
-
.RS 14
|
|
290
|
-
.IP \(bu 2
|
|
291
|
-
auto
|
|
292
|
-
.IP \(bu 2
|
|
293
|
-
base
|
|
294
|
-
.IP \(bu 2
|
|
295
|
-
previous
|
|
296
|
-
.RE
|
|
297
|
-
.TP
|
|
298
|
-
\fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
|
|
299
|
-
Whether the finished ROM keeps its copier header.
|
|
300
|
-
|
|
301
|
-
auto Keep headers emulators need (iNES, FDS, LNX, A78) and drop the ones
|
|
302
|
-
they do not (SNES, PCE, Game Doctor). The default.
|
|
303
|
-
keep Put back a header that was stripped in order to patch.
|
|
304
|
-
strip Write a headerless ROM, removing the header if it is still there.
|
|
305
|
-
|
|
306
|
-
The chain produces one file, so this is a single setting; if repeated, the last
|
|
307
|
-
value wins.
|
|
308
|
-
|
|
309
|
-
When the header decision changes which extension is conventional, the output
|
|
310
|
-
extension follows (SNES .smc becomes headerless .sfc, for instance) and the
|
|
311
|
-
report says so. Extensions unrelated to headers are never touched.
|
|
312
|
-
.br
|
|
313
|
-
|
|
314
|
-
.br
|
|
315
|
-
\fIPossible values:\fR
|
|
316
|
-
.RS 14
|
|
317
|
-
.IP \(bu 2
|
|
318
|
-
keep
|
|
319
|
-
.IP \(bu 2
|
|
320
|
-
strip
|
|
321
|
-
.IP \(bu 2
|
|
322
|
-
auto
|
|
323
|
-
.RE
|
|
324
|
-
.TP
|
|
325
|
-
\fB\-\-repair\-checksum\fR
|
|
326
|
-
Recompute the ROM\*(Aqs internal header checksum afterwards, so the console does not reject it (SNES, NES, GB, GBA, Mega Drive, SMS, N64, NDS)
|
|
327
|
-
.TP
|
|
328
|
-
\fB\-\-n64\-byte\-order\fR \fI<N64_BYTE_ORDER>\fR
|
|
329
|
-
Byte order to put an N64 ROM in before each patch runs.
|
|
330
|
-
|
|
331
|
-
N64 dumps circulate in three interleavings (.z64 big\-endian, .v64 byte\-swapped,
|
|
332
|
-
\&.n64 little\-endian) and a patch only matches one of them.
|
|
333
|
-
|
|
334
|
-
auto Match whichever order the patch\*(Aqs source CRC32 names. The
|
|
335
|
-
default, and almost always right. For the first patch, one
|
|
336
|
-
that carries no checksum (IPS) falls back to the shape of its
|
|
337
|
-
changes; an order settled that way is named in the report.
|
|
338
|
-
keep Leave the ROM as it is.
|
|
339
|
-
big\-endian Rewrite to .z64 order.
|
|
340
|
-
little\-endian Rewrite to .n64 order.
|
|
341
|
-
byte\-swapped Rewrite to .v64 order.
|
|
342
|
-
|
|
343
|
-
Repeatable, one per patch; a short list carries its last value forward. The
|
|
344
|
-
output is written back in the order the input arrived in.
|
|
345
|
-
.br
|
|
346
|
-
|
|
347
|
-
.br
|
|
348
|
-
\fIPossible values:\fR
|
|
349
|
-
.RS 14
|
|
350
|
-
.IP \(bu 2
|
|
351
|
-
auto
|
|
352
|
-
.IP \(bu 2
|
|
353
|
-
keep
|
|
354
|
-
.IP \(bu 2
|
|
355
|
-
big\-endian
|
|
356
|
-
.IP \(bu 2
|
|
357
|
-
little\-endian
|
|
358
|
-
.IP \(bu 2
|
|
359
|
-
byte\-swapped
|
|
360
|
-
.RE
|
|
361
|
-
.TP
|
|
362
|
-
\fB\-\-ignore\-checksum\-validation\fR
|
|
363
|
-
Apply the patch even when its own checksums do not match. Can produce a broken ROM
|
|
364
|
-
.SH DIAGNOSTICS/AUTHORING
|
|
365
|
-
.TP
|
|
366
|
-
\fB\-\-patch\-input\-check\fR \fI<ALGO=HEX>\fR
|
|
367
|
-
Expected input checks for the preceding patch (repeatable, comma\-separable)
|
|
368
|
-
.TP
|
|
369
|
-
\fB\-\-patch\-output\-check\fR \fI<ALGO=HEX>\fR
|
|
370
|
-
Expected output checks for the preceding patch (repeatable, comma\-separable)
|
|
371
|
-
.TP
|
|
372
|
-
\fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
|
|
373
|
-
Fail unless the patched ROM has this checksum, as in sha1=abc... (repeatable, comma\-separable)
|
|
374
|
-
.TP
|
|
375
|
-
\fB\-\-code\fR \fI<CODES>\fR
|
|
376
|
-
Game Genie or GameShark/Pro Action Replay code to bake into the ROM. Repeat for each code
|
|
377
|
-
.TP
|
|
378
|
-
\fB\-\-code\-system\fR \fI<CODE_SYSTEM>\fR
|
|
379
|
-
Console the \-\-code values are for (nes, snes, genesis, 32x, sms, gamegear, sg1000, gameboy, gba, psx), when the ROM header does not say
|
|
380
|
-
.TP
|
|
381
|
-
\fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
|
|
382
|
-
Cheat scheme: auto, game\-genie, gameshark/par, xploder, pro\-action\-rocky, gold\-finger, game\-shark\-v1[\-raw], or action\-replay\-v3[\-raw]
|
|
383
|
-
.TP
|
|
384
|
-
\fB\-\-emit\-bundle\fR \fI<PATH>\fR
|
|
385
|
-
Also write a rom\-weaver\-bundle.json recording this run, so someone else can repeat it
|
|
386
|
-
.TP
|
|
387
|
-
\fB\-\-tui\fR
|
|
388
|
-
Ask for each patch\*(Aqs name, version, and author, then apply and write a bundle. Needs a terminal
|
|
389
|
-
.SH CHEATS
|
|
390
|
-
.TP
|
|
391
|
-
\fB\-\-cheat\fR \fI<ID_OR_DESCRIPTION>\fR
|
|
392
|
-
Database cheat to use, by record ID or exact description. Repeat for each cheat
|
|
393
|
-
.TP
|
|
394
|
-
\fB\-\-cheat\-database\fR \fI<DIR>\fR
|
|
395
|
-
Directory holding manifest.json and the <system>.json cheat shards. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then the per\-user data directory
|
|
396
|
-
.TP
|
|
397
|
-
\fB\-\-cheat\-system\fR \fI<SYS>\fR
|
|
398
|
-
Console the cheat shard is for (nes, snes, genesis, gameboy, gameboy\-color, gba), when the ROM header does not say
|
|
399
|
-
.TP
|
|
400
|
-
\fB\-\-game\fR \fI<ID>\fR
|
|
401
|
-
Use this database game ID instead of matching the ROM by checksum or title
|
|
402
|
-
.TP
|
|
403
|
-
\fB\-\-allow\-cheat\-conflicts\fR
|
|
404
|
-
Let a later cheat overwrite an earlier one at the same offset instead of failing
|
|
405
|
-
.SH PERFORMANCE
|
|
406
|
-
.TP
|
|
407
|
-
\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
|
|
408
|
-
How many threads to use at most. auto uses every core; a format may still use fewer
|
|
13
|
+
Print help
|
|
409
14
|
.SH "GLOBAL OPTIONS"
|
|
410
15
|
.TP
|
|
411
16
|
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
@@ -464,6 +69,13 @@ Turn colors off
|
|
|
464
69
|
.TP
|
|
465
70
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
466
71
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
467
|
-
.SH
|
|
468
|
-
|
|
469
|
-
|
|
72
|
+
.SH SUBCOMMANDS
|
|
73
|
+
.TP
|
|
74
|
+
rom\-weaver\-weave\-create(1)
|
|
75
|
+
Write a rom\-weaver\-weave.json recipe from local ROM and patch files
|
|
76
|
+
.TP
|
|
77
|
+
rom\-weaver\-weave\-parse(1)
|
|
78
|
+
Read a rom\-weaver\-weave.json recipe and report what it points at
|
|
79
|
+
.TP
|
|
80
|
+
rom\-weaver\-weave\-schema(1)
|
|
81
|
+
Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
|
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.21.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver \- Inspect, extract, checksum, compress, trim, and patch ROMs and disc images
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -93,7 +93,7 @@ rom\-weaver\-identify(1)
|
|
|
93
93
|
Identify a ROM title from its checksums
|
|
94
94
|
.TP
|
|
95
95
|
rom\-weaver\-setup(1)
|
|
96
|
-
Install the offline identify
|
|
96
|
+
Install the offline identify and cheat databases
|
|
97
97
|
.TP
|
|
98
98
|
rom\-weaver\-cheat(1)
|
|
99
99
|
List the cheat database\*(Aqs entries for a ROM
|
|
@@ -107,8 +107,8 @@ Cut the padding off a ROM, or put it back
|
|
|
107
107
|
rom\-weaver\-patch(1)
|
|
108
108
|
Apply, create, or check ROM patches
|
|
109
109
|
.TP
|
|
110
|
-
rom\-weaver\-
|
|
111
|
-
Build and read rom\-weaver\-
|
|
110
|
+
rom\-weaver\-weave(1)
|
|
111
|
+
Build and read rom\-weaver\-weave.json patch recipes
|
|
112
112
|
.TP
|
|
113
113
|
rom\-weaver\-save(1)
|
|
114
114
|
Inspect and edit supported persistent game saves
|
|
@@ -116,9 +116,6 @@ Inspect and edit supported persistent game saves
|
|
|
116
116
|
rom\-weaver\-tools(1)
|
|
117
117
|
One\-off recovery tools
|
|
118
118
|
.TP
|
|
119
|
-
rom\-weaver\-weave(1)
|
|
120
|
-
Apply one or more patches to a ROM, in order (same as `patch apply`)
|
|
121
|
-
.TP
|
|
122
119
|
rom\-weaver\-completions(1)
|
|
123
120
|
Print a tab\-completion script for your shell
|
|
124
121
|
.TP
|
|
@@ -148,4 +145,4 @@ Examples:
|
|
|
148
145
|
|
|
149
146
|
Full guide: https://rom\-weaver.com/docs/cli
|
|
150
147
|
.SH VERSION
|
|
151
|
-
v0.
|
|
148
|
+
v0.21.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rom-weaver",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.21.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",
|
|
@@ -69,10 +69,13 @@
|
|
|
69
69
|
"docs/man/rom-weaver-tools.1",
|
|
70
70
|
"docs/man/rom-weaver-tools-ppf-undo.1",
|
|
71
71
|
"docs/man/rom-weaver-trim.1",
|
|
72
|
-
"docs/man/rom-weaver-weave.1"
|
|
72
|
+
"docs/man/rom-weaver-weave.1",
|
|
73
|
+
"docs/man/rom-weaver-weave-create.1",
|
|
74
|
+
"docs/man/rom-weaver-weave-parse.1",
|
|
75
|
+
"docs/man/rom-weaver-weave-schema.1"
|
|
73
76
|
],
|
|
74
77
|
"dependencies": {
|
|
75
|
-
"@rom-weaver/cli": "0.
|
|
78
|
+
"@rom-weaver/cli": "0.21.0"
|
|
76
79
|
},
|
|
77
80
|
"files": [
|
|
78
81
|
"bin/rom-weaver.mjs",
|