rom-weaver 0.14.1 → 0.15.1

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.
Files changed (33) hide show
  1. package/docs/man/rom-weaver-bundle-create.1 +285 -0
  2. package/docs/man/rom-weaver-bundle-parse.1 +101 -0
  3. package/docs/man/rom-weaver-bundle-schema.1 +70 -0
  4. package/docs/man/rom-weaver-bundle.1 +72 -0
  5. package/docs/man/rom-weaver-checksum.1 +135 -0
  6. package/docs/man/rom-weaver-completions.1 +87 -0
  7. package/docs/man/rom-weaver-compress.1 +183 -0
  8. package/docs/man/rom-weaver-extract.1 +158 -0
  9. package/docs/man/rom-weaver-formats.1 +66 -0
  10. package/docs/man/rom-weaver-identify-database-import-redump.1 +68 -0
  11. package/docs/man/rom-weaver-identify-database-install-all.1 +65 -0
  12. package/docs/man/rom-weaver-identify-database-install-group.1 +71 -0
  13. package/docs/man/rom-weaver-identify-database-install.1 +74 -0
  14. package/docs/man/rom-weaver-identify-database-list.1 +65 -0
  15. package/docs/man/rom-weaver-identify-database-path.1 +65 -0
  16. package/docs/man/rom-weaver-identify-database-remove.1 +68 -0
  17. package/docs/man/rom-weaver-identify-database-status.1 +65 -0
  18. package/docs/man/rom-weaver-identify-database-update.1 +71 -0
  19. package/docs/man/rom-weaver-identify-database.1 +90 -0
  20. package/docs/man/rom-weaver-identify.1 +123 -0
  21. package/docs/man/rom-weaver-man.1 +78 -0
  22. package/docs/man/rom-weaver-patch-apply.1 +420 -0
  23. package/docs/man/rom-weaver-patch-create.1 +172 -0
  24. package/docs/man/rom-weaver-patch-validate.1 +168 -0
  25. package/docs/man/rom-weaver-patch.1 +72 -0
  26. package/docs/man/rom-weaver-probe.1 +96 -0
  27. package/docs/man/rom-weaver-setup.1 +76 -0
  28. package/docs/man/rom-weaver-tools-ppf-undo.1 +74 -0
  29. package/docs/man/rom-weaver-tools.1 +66 -0
  30. package/docs/man/rom-weaver-trim.1 +130 -0
  31. package/docs/man/rom-weaver-weave.1 +420 -0
  32. package/docs/man/rom-weaver.1 +136 -0
  33. package/package.json +37 -2
@@ -0,0 +1,420 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-patch-apply 1 "rom-weaver-patch-apply "
4
+ .SH NAME
5
+ rom\-weaver\-patch\-apply \- Apply one or more patches to a ROM, in order
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver patch apply\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-no\-progress\fR] [\fB\-\-target\fR] [\fB\-\-filter\fR] [\fB\-\-log\-level\fR] [\fB\-\-no\-extract\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-no\-ignore\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\fR] [\fB\-\-color\fR] [\fB\-\-patch\-select\fR] [\fB\-\-no\-color\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-bundle\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-with\fR] [\fB\-\-without\fR] [\fB\-\-no\-compress\fR] [\fB\-\-compress\-format\fR] [\fB\-\-compress\-codec\fR] [\fB\-\-compress\-level\fR] [\fB\-\-assume\-in\fR] [\fB\-\-expect\-in\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-output\-header\fR] [\fB\-\-repair\-checksum\fR] [\fB\-\-n64\-byte\-order\fR] [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-\-expect\-out\fR] [\fB\-\-code\fR] [\fB\-\-code\-system\fR] [\fB\-\-code\-kind\fR] [\fB\-\-emit\-bundle\fR] [\fB\-\-tui\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
8
+ .SH DESCRIPTION
9
+ Apply one or more patches to a ROM, in order.
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.
36
+ .SH OPTIONS
37
+ .TP
38
+ \fB\-\-force\fR
39
+ Overwrite the output if it already exists (without this, the command stops instead)
40
+ .TP
41
+ \fB\-n\fR, \fB\-\-dry\-run\fR
42
+ Print the plan (inputs, patches, output, format, codec, level, threads) and stop without writing
43
+ .TP
44
+ \fB\-h\fR, \fB\-\-help\fR
45
+ Print help (see a summary with \*(Aq\-h\*(Aq)
46
+ .SH BASIC
47
+ .TP
48
+ \fB\-i\fR, \fB\-\-input\fR \fI<PATH>\fR
49
+ ROM to patch. May be an archive, a disc sheet (.cue/.gdi), or a bundle
50
+ .TP
51
+ \fB\-\-patch\fR \fI<PATCHES>\fR
52
+ Patch to apply. Repeat once per patch; they run in the order given, each on the
53
+ result of the last.
54
+
55
+ Leave it out and rom\-weaver looks for RetroArch\-style patches sitting next to
56
+ the ROM inside the input archive.
57
+ .TP
58
+ \fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
59
+ Where to write the patched ROM. Optional when a bundle already names the output
60
+ .TP
61
+ \fB\-\-no\-compress\fR
62
+ Write a plain ROM instead of compressing the result
63
+ .TP
64
+ \fB\-\-compress\-format\fR \fI<COMPRESS_FORMAT>\fR
65
+ Format to compress the patched ROM into, such as zip, 7z, chd, rvz, or z3ds.
66
+
67
+ Normally you do not need this: the format comes from the \-\-output extension.
68
+ Pass it when the output name has no usable extension. If it disagrees with the
69
+ extension, this flag wins and a warning is printed. Use \-\-no\-compress to write
70
+ a plain ROM instead.
71
+ .br
72
+
73
+ .br
74
+ \fIPossible values:\fR
75
+ .RS 14
76
+ .IP \(bu 2
77
+ zip
78
+ .IP \(bu 2
79
+ 7z
80
+ .IP \(bu 2
81
+ chd
82
+ .IP \(bu 2
83
+ rvz
84
+ .IP \(bu 2
85
+ z3ds
86
+ .RE
87
+ .TP
88
+ \fB\-\-compress\-codec\fR \fI<COMPRESS_CODEC>\fR
89
+ Compression method for the patched ROM, written as codec or codec:level.
90
+
91
+ Each format has its own codecs, and each picks a sensible one on its own, so
92
+ this is only for overriding that choice. CHD takes a list, tried in order:
93
+
94
+ \-\-compress\-codec cdzs:19,cdzl,cdfl
95
+
96
+ Without :level, a codec follows the \-\-compress\-level profile.
97
+ .br
98
+
99
+ .br
100
+ \fIPossible values:\fR
101
+ .RS 14
102
+ .IP \(bu 2
103
+ store
104
+ .IP \(bu 2
105
+ deflate
106
+ .IP \(bu 2
107
+ zstd
108
+ .IP \(bu 2
109
+ lzma
110
+ .IP \(bu 2
111
+ lzma2
112
+ .IP \(bu 2
113
+ zlib
114
+ .IP \(bu 2
115
+ huff
116
+ .IP \(bu 2
117
+ flac
118
+ .IP \(bu 2
119
+ cdzs
120
+ .IP \(bu 2
121
+ cdlz
122
+ .IP \(bu 2
123
+ cdzl
124
+ .IP \(bu 2
125
+ cdfl
126
+ .IP \(bu 2
127
+ avhuff
128
+ .RE
129
+ .TP
130
+ \fB\-\-compress\-level\fR \fI<COMPRESS_LEVEL>\fR
131
+ How hard to compress: min, very\-low, low, medium, high, very\-high, or max [default: max]
132
+ .br
133
+
134
+ .br
135
+ \fIPossible values:\fR
136
+ .RS 14
137
+ .IP \(bu 2
138
+ min
139
+ .IP \(bu 2
140
+ very\-low
141
+ .IP \(bu 2
142
+ low
143
+ .IP \(bu 2
144
+ medium
145
+ .IP \(bu 2
146
+ high
147
+ .IP \(bu 2
148
+ very\-high
149
+ .IP \(bu 2
150
+ max
151
+ .RE
152
+ .SH ARCHIVE/BUNDLE
153
+ .TP
154
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
155
+ 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
156
+ .TP
157
+ \fB\-\-target\fR \fI<TARGET>\fR
158
+ For a .cue or .gdi input, which track gets the patch. Matched like \-\-select and must hit exactly one track
159
+ .TP
160
+ \fB\-\-filter\fR \fI<FILTER>\fR
161
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
162
+ .br
163
+
164
+ .br
165
+ \fIPossible values:\fR
166
+ .RS 14
167
+ .IP \(bu 2
168
+ rom
169
+ .IP \(bu 2
170
+ patch
171
+ .RE
172
+ .TP
173
+ \fB\-\-no\-extract\fR
174
+ Do not look inside archives; treat the input and every patch as raw files
175
+ .TP
176
+ \fB\-\-no\-ignore\fR
177
+ Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
178
+ .TP
179
+ \fB\-\-patch\-select\fR \fI<GLOB>\fR
180
+ Pick which file to use inside the \-\-patch archive before it. Repeatable, one per \-\-patch; falls back to \-\-select
181
+ .TP
182
+ \fB\-\-bundle\fR \fI<BUNDLE>\fR
183
+ Follow a rom\-weaver\-bundle.json recipe, which lists the patches, their order,
184
+ and the expected checksums. Takes a file path or an http(s) URL.
185
+
186
+ You can usually skip this flag. A bundle is picked up automatically when
187
+ \-\-input is a rom\-weaver\-bundle.json (optionally .gz, .bz2, .xz, or .zst), or an
188
+ archive with one at its root, and you passed no \-\-patch of your own.
189
+ .TP
190
+ \fB\-\-with\fR \fI<GLOB>\fR
191
+ Turn on a bundle patch the bundle leaves off by default, matched by name or file name (repeatable)
192
+ .TP
193
+ \fB\-\-without\fR \fI<GLOB>\fR
194
+ Turn off a bundle patch, matched by name or file name (repeatable)
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 Work it out from the checksums (the default).
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; it binds to the most recent
265
+ \-\-patch and carries forward until the next occurrence. An occurrence before any
266
+ \-\-patch applies to every patch.
267
+ .br
268
+
269
+ .br
270
+ \fIPossible values:\fR
271
+ .RS 14
272
+ .IP \(bu 2
273
+ auto
274
+ .IP \(bu 2
275
+ base
276
+ .IP \(bu 2
277
+ previous
278
+ .RE
279
+ .TP
280
+ \fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
281
+ Whether the finished ROM keeps its copier header.
282
+
283
+ auto Keep headers emulators need (iNES, FDS, LNX, A78) and drop the ones
284
+ they do not (SNES, PCE, Game Doctor). The default.
285
+ keep Put back a header that was stripped in order to patch.
286
+ strip Write a headerless ROM, removing the header if it is still there.
287
+
288
+ The chain produces one file, so this is a single setting; if repeated, the last
289
+ value wins.
290
+
291
+ When the header decision changes which extension is conventional, the output
292
+ extension follows (SNES .smc becomes headerless .sfc, for instance) and the
293
+ report says so. Extensions unrelated to headers are never touched.
294
+ .br
295
+
296
+ .br
297
+ \fIPossible values:\fR
298
+ .RS 14
299
+ .IP \(bu 2
300
+ keep
301
+ .IP \(bu 2
302
+ strip
303
+ .IP \(bu 2
304
+ auto
305
+ .RE
306
+ .TP
307
+ \fB\-\-repair\-checksum\fR
308
+ Recompute the ROM\*(Aqs internal header checksum afterwards, so the console does not reject it (SNES, NES, GB, GBA, Mega Drive, SMS, N64, NDS)
309
+ .TP
310
+ \fB\-\-n64\-byte\-order\fR \fI<N64_BYTE_ORDER>\fR
311
+ Byte order to put an N64 ROM in before each patch runs.
312
+
313
+ N64 dumps circulate in three interleavings (.z64 big\-endian, .v64 byte\-swapped,
314
+ \&.n64 little\-endian) and a patch only matches one of them.
315
+
316
+ auto Match whichever order the patch\*(Aqs source CRC32 names. The
317
+ default, and almost always right. For the first patch, one
318
+ that carries no checksum (IPS) falls back to the shape of its
319
+ changes; an order settled that way is named in the report.
320
+ keep Leave the ROM as it is.
321
+ big\-endian Rewrite to .z64 order.
322
+ little\-endian Rewrite to .n64 order.
323
+ byte\-swapped Rewrite to .v64 order.
324
+
325
+ Repeatable, one per patch; a short list carries its last value forward. The
326
+ output is written back in the order the input arrived in.
327
+ .br
328
+
329
+ .br
330
+ \fIPossible values:\fR
331
+ .RS 14
332
+ .IP \(bu 2
333
+ auto
334
+ .IP \(bu 2
335
+ keep
336
+ .IP \(bu 2
337
+ big\-endian
338
+ .IP \(bu 2
339
+ little\-endian
340
+ .IP \(bu 2
341
+ byte\-swapped
342
+ .RE
343
+ .TP
344
+ \fB\-\-ignore\-checksum\-validation\fR
345
+ Apply the patch even when its own checksums do not match. Can produce a broken ROM
346
+ .SH DIAGNOSTICS/AUTHORING
347
+ .TP
348
+ \fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
349
+ Fail unless the patched ROM has this checksum, as in sha1=abc... (repeatable, comma\-separable)
350
+ .TP
351
+ \fB\-\-code\fR \fI<CODES>\fR
352
+ Game Genie or GameShark/Pro Action Replay code to bake into the ROM. Repeat for each code
353
+ .TP
354
+ \fB\-\-code\-system\fR \fI<CODE_SYSTEM>\fR
355
+ Console the \-\-code values are for (nes, snes, genesis, gameboy, gba, psx), when the ROM header does not say
356
+ .TP
357
+ \fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
358
+ Which cheat scheme the \-\-code values use: auto, game\-genie, gameshark/par, or xploder
359
+ .TP
360
+ \fB\-\-emit\-bundle\fR \fI<PATH>\fR
361
+ Also write a rom\-weaver\-bundle.json recording this run, so someone else can repeat it
362
+ .TP
363
+ \fB\-\-tui\fR
364
+ Ask for each patch\*(Aqs name, version, and author, then apply and write a bundle. Needs a terminal
365
+ .SH PERFORMANCE
366
+ .TP
367
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
368
+ How many threads to use at most. auto uses every core; a format may still use fewer
369
+ .SH "GLOBAL OPTIONS"
370
+ .TP
371
+ \fB\-\-json\fR
372
+ Print one JSON object per line instead of human\-readable output
373
+ .TP
374
+ \fB\-\-progress\fR
375
+ Show progress even when output is piped to a file or another program
376
+ .TP
377
+ \fB\-\-no\-progress\fR
378
+ Hide progress
379
+ .TP
380
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
381
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
382
+ .br
383
+
384
+ .br
385
+ \fIPossible values:\fR
386
+ .RS 14
387
+ .IP \(bu 2
388
+ off
389
+ .IP \(bu 2
390
+ error
391
+ .IP \(bu 2
392
+ warn
393
+ .IP \(bu 2
394
+ info
395
+ .IP \(bu 2
396
+ debug
397
+ .IP \(bu 2
398
+ trace
399
+ .RE
400
+ .TP
401
+ \fB\-v\fR, \fB\-\-verbose\fR
402
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
403
+ .TP
404
+ \fB\-q\fR, \fB\-\-quiet\fR
405
+ Log errors only
406
+ .TP
407
+ \fB\-\-dep\-trace\fR
408
+ Also log trace output from bundled libraries (for bug reports)
409
+ .TP
410
+ \fB\-\-color\fR
411
+ Keep colors even when output is piped
412
+ .TP
413
+ \fB\-\-no\-color\fR
414
+ Turn colors off
415
+ .TP
416
+ \fB\-y\fR, \fB\-\-yes\fR
417
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
418
+ .SH EXTRA
419
+ Example:
420
+ rom\-weaver patch apply \-i game.sfc \-\-patch hack.bps \-o hacked.sfc
@@ -0,0 +1,172 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-patch-create 1 "rom-weaver-patch-create "
4
+ .SH NAME
5
+ rom\-weaver\-patch\-create \- Build a patch from an original ROM and a changed one
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver patch create\fR [\fB\-\-json\fR] [\fB\-\-modified\fR] [\fB\-\-progress\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-plan\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-checksum\-name\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-assume\-in\fR] [\fB\-\-color\fR] [\fB\-\-code\fR] [\fB\-\-no\-color\fR] [\fB\-\-code\-system\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-code\-kind\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-solid\-system\fR] [\fB\-\-solid\-game\fR] [\fB\-\-solid\-hack\fR] [\fB\-\-solid\-version\fR] [\fB\-\-solid\-author\fR] [\fB\-\-solid\-contact\fR] [\fB\-\-solid\-comment\fR] [\fB\-\-solid\-extended\fR] [\fB\-\-xdelta\-secondary\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-\-original\fR>
8
+ .SH DESCRIPTION
9
+ Build a patch from an original ROM and a changed one, so you can share the
10
+ change without sharing the ROM.
11
+ .PP
12
+ The format comes from the \-\-output extension, so `\-\-output hack.bps` writes a
13
+ BPS patch. Use \-\-plan to see which formats suit these two files before
14
+ committing to one.
15
+ .PP
16
+ Instead of a second ROM, \-\-code builds the patch from Game Genie or
17
+ GameShark/Pro Action Replay codes.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-\-original\fR \fI<PATH>\fR
21
+ The unmodified ROM
22
+ .TP
23
+ \fB\-\-modified\fR \fI<MODIFIED>\fR
24
+ The changed ROM. Leave out when using \-\-code, which produces the changed ROM for you
25
+ .TP
26
+ \fB\-f\fR, \fB\-\-format\fR \fI<FORMAT>\fR
27
+ Patch format, such as bps, ips, or xdelta.
28
+
29
+ Normally you do not need this: the format comes from the \-\-output extension, so
30
+ `\-\-output hack.bps` writes a BPS patch. Pass it when the output name has no
31
+ recognizable patch extension.
32
+
33
+ Common alternate spellings are accepted, so `xdelta3` works as well as `xdelta`
34
+ and `bsdiff` as well as `bdf`. The CLI guide lists every alias.
35
+ .TP
36
+ \fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
37
+ Where to write the patch. Required unless \-\-plan is used
38
+ .TP
39
+ \fB\-\-plan\fR
40
+ Only report which formats suit these two ROMs; write nothing
41
+ .TP
42
+ \fB\-\-ignore\-checksum\-validation\fR
43
+ Write the patch even when the format\*(Aqs own consistency checks fail, and leave its checksums out
44
+ .TP
45
+ \fB\-\-checksum\-name\fR
46
+ Put the original ROM\*(Aqs crc32 in the patch file name, as [crc32:HEX].
47
+
48
+ Formats like IPS carry no checksum of their own, so there is nothing to catch
49
+ the patch being applied to the wrong ROM. rom\-weaver reads this token back on
50
+ apply and verifies the input, as long as the file name survives.
51
+ .TP
52
+ \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
53
+ Take the original ROM\*(Aqs checksum on trust rather than reading the file, as in crc32=1234abcd (repeatable, comma\-separable)
54
+ .TP
55
+ \fB\-\-code\fR \fI<CODES>\fR
56
+ Build the patch from a Game Genie or GameShark/Pro Action Replay code instead of a second ROM. Repeat for each code; cannot be used with \-\-modified
57
+ .TP
58
+ \fB\-\-code\-system\fR \fI<CODE_SYSTEM>\fR
59
+ Console the \-\-code values are for (nes, snes, genesis, gameboy, gba, psx), when the ROM header does not say
60
+ .TP
61
+ \fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
62
+ Which cheat scheme the \-\-code values use: auto, game\-genie, gameshark/par, or xploder
63
+ .TP
64
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
65
+ How many threads to use at most. auto uses every core; a format may still use fewer
66
+ .TP
67
+ \fB\-\-solid\-system\fR \fI<SOLID_SYSTEM>\fR
68
+ SOLID patches only: console the ROM is for
69
+ .TP
70
+ \fB\-\-solid\-game\fR \fI<SOLID_GAME>\fR
71
+ SOLID patches only: name of the game
72
+ .TP
73
+ \fB\-\-solid\-hack\fR \fI<SOLID_HACK>\fR
74
+ SOLID patches only: name of the hack
75
+ .TP
76
+ \fB\-\-solid\-version\fR \fI<SOLID_VERSION>\fR
77
+ SOLID patches only: version of the hack. Switches the patch to its extended header
78
+ .TP
79
+ \fB\-\-solid\-author\fR \fI<SOLID_AUTHOR>\fR
80
+ SOLID patches only: who made the hack. Switches the patch to its extended header
81
+ .TP
82
+ \fB\-\-solid\-contact\fR \fI<SOLID_CONTACT>\fR
83
+ SOLID patches only: how to reach the author. Switches the patch to its extended header
84
+ .TP
85
+ \fB\-\-solid\-comment\fR \fI<SOLID_COMMENT>\fR
86
+ SOLID patches only: free\-form note. Switches the patch to its extended header
87
+ .TP
88
+ \fB\-\-solid\-extended\fR
89
+ SOLID patches only: use the extended header even with none of the extended fields filled in
90
+ .TP
91
+ \fB\-\-xdelta\-secondary\fR \fI<XDELTA_SECONDARY>\fR [default: none]
92
+ xdelta patches only: compress the patch\*(Aqs own contents.
93
+
94
+ none Leave it uncompressed. The default, and what xdelta3 does without \-S.
95
+ lzma Add LZMA, like xdelta3 \-S lzma.
96
+ djw xdelta3\*(Aqs Huffman coder.
97
+ fgk xdelta3\*(Aqs adaptive Huffman coder.
98
+ auto Try djw, lzma, and fgk, and keep whichever comes out smallest.
99
+
100
+ Leaving it at none is usually right: patch payloads are often already\-compressed
101
+ game assets, and the patch tends to get compressed again downstream anyway.
102
+ .br
103
+
104
+ .br
105
+ \fIPossible values:\fR
106
+ .RS 14
107
+ .IP \(bu 2
108
+ auto
109
+ .IP \(bu 2
110
+ lzma
111
+ .IP \(bu 2
112
+ djw
113
+ .IP \(bu 2
114
+ fgk
115
+ .IP \(bu 2
116
+ none
117
+ .RE
118
+ .TP
119
+ \fB\-\-force\fR
120
+ Overwrite the output if it already exists (without this, the command stops instead)
121
+ .TP
122
+ \fB\-h\fR, \fB\-\-help\fR
123
+ Print help (see a summary with \*(Aq\-h\*(Aq)
124
+ .SH "GLOBAL OPTIONS"
125
+ .TP
126
+ \fB\-\-json\fR
127
+ Print one JSON object per line instead of human\-readable output
128
+ .TP
129
+ \fB\-\-progress\fR
130
+ Show progress even when output is piped to a file or another program
131
+ .TP
132
+ \fB\-\-no\-progress\fR
133
+ Hide progress
134
+ .TP
135
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
136
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
137
+ .br
138
+
139
+ .br
140
+ \fIPossible values:\fR
141
+ .RS 14
142
+ .IP \(bu 2
143
+ off
144
+ .IP \(bu 2
145
+ error
146
+ .IP \(bu 2
147
+ warn
148
+ .IP \(bu 2
149
+ info
150
+ .IP \(bu 2
151
+ debug
152
+ .IP \(bu 2
153
+ trace
154
+ .RE
155
+ .TP
156
+ \fB\-v\fR, \fB\-\-verbose\fR
157
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
158
+ .TP
159
+ \fB\-q\fR, \fB\-\-quiet\fR
160
+ Log errors only
161
+ .TP
162
+ \fB\-\-dep\-trace\fR
163
+ Also log trace output from bundled libraries (for bug reports)
164
+ .TP
165
+ \fB\-\-color\fR
166
+ Keep colors even when output is piped
167
+ .TP
168
+ \fB\-\-no\-color\fR
169
+ Turn colors off
170
+ .TP
171
+ \fB\-y\fR, \fB\-\-yes\fR
172
+ Answer yes to every confirmation instead of asking. Does not choose between candidates