rom-weaver 0.20.1 → 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.
@@ -1,41 +1,41 @@
1
1
  .ie \n(.g .ds Aq \(aq
2
2
  .el .ds Aq '
3
- .TH rom-weaver-bundle-create 1 "rom-weaver-bundle-create "
3
+ .TH rom-weaver-weave-create 1 "rom-weaver-weave-create "
4
4
  .SH NAME
5
- rom\-weaver\-bundle\-create \- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
5
+ rom\-weaver\-weave\-create \- Write a rom\-weaver\-weave.json recipe from local ROM and patch files
6
6
  .SH SYNOPSIS
7
- \fBrom\-weaver bundle create\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-assume\-in\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-rom\-url\fR] [\fB\-\-progress\fR] [\fB\-\-rom\-name\fR] [\fB\-\-no\-progress\fR] [\fB\-\-rom\-member\fR] [\fB\-\-log\-level\fR] [\fB\-\-patch\fR] [\fB\-\-patch\-id\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-version\fR] [\fB\-\-patch\-name\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-description\fR] [\fB\-\-color\fR] [\fB\-\-patch\-author\fR] [\fB\-\-no\-color\fR] [\fB\-\-patch\-label\fR] [\fB\-\-patch\-optional\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-patch\-source\-url\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-default\-patch\-basis\fR] [\fB\-\-patch\-expect\-in\fR] [\fB\-\-patch\-expect\-out\fR] [\fB\-\-expect\-out\fR] [\fB\-\-output\-name\fR] [\fB\-\-output\-header\fR] [\fB\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-bundle\fR] [\fB\-\-bundle\-rom\fR] [\fB\-\-no\-bundle\-rom\fR] [\fB\-\-checksum\fR] [\fB\-\-from\fR] [\fB\-\-schema\-ref\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-output\fR>
7
+ \fBrom\-weaver weave create\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-assume\-in\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-rom\-url\fR] [\fB\-\-progress\fR] [\fB\-\-rom\-name\fR] [\fB\-\-no\-progress\fR] [\fB\-\-rom\-member\fR] [\fB\-\-log\-level\fR] [\fB\-\-patch\fR] [\fB\-\-patch\-id\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-version\fR] [\fB\-\-patch\-name\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-description\fR] [\fB\-\-color\fR] [\fB\-\-patch\-author\fR] [\fB\-\-no\-color\fR] [\fB\-\-patch\-label\fR] [\fB\-\-patch\-optional\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-patch\-source\-url\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-default\-patch\-basis\fR] [\fB\-\-patch\-expect\-in\fR] [\fB\-\-patch\-expect\-out\fR] [\fB\-\-expect\-out\fR] [\fB\-\-output\-name\fR] [\fB\-\-output\-header\fR] [\fB\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-weave\fR] [\fB\-\-weave\-rom\fR] [\fB\-\-no\-weave\-rom\fR] [\fB\-\-checksum\fR] [\fB\-\-from\fR] [\fB\-\-schema\-ref\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-output\fR>
8
8
  .SH DESCRIPTION
9
- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files.
9
+ Write a rom\-weaver\-weave.json recipe from local ROM and patch files.
10
10
  .PP
11
- A bundle records which ROM the patches are for, what order they run in, and
11
+ A weave records which ROM the patches are for, what order they run in, and
12
12
  what the result should hash to. Hand it to someone else and
13
- `rom\-weaver patch apply \-\-bundle` reproduces your exact result.
13
+ `rom\-weaver patch apply \-\-weave` reproduces your exact result.
14
14
  .PP
15
15
  Checksums come from the real files, so nothing here is taken on faith. Every
16
16
  \-\-patch\-* flag describes the \-\-patch before it.
17
17
  .PP
18
- \-\-output names the recipe itself; add .gz or .zst to compress it. \-\-bundle
18
+ \-\-output names the recipe itself; add .gz or .zst to compress it. \-\-weave
19
19
  additionally packs the recipe and its files into one shareable archive.
20
20
  .SH OPTIONS
21
21
  .TP
22
22
  \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
23
- ROM the patches apply to. Its checksums and size are read from the file and recorded in the bundle
23
+ ROM the patches apply to. Its checksums and size are read from the file and recorded in the weave
24
24
  .TP
25
25
  \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
26
26
  Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc32=1234abcd,size=1048576 (repeatable, comma\-separable)
27
27
  .TP
28
28
  \fB\-\-rom\-url\fR \fI<ROM_URL>\fR
29
- Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the bundle records only this url
29
+ Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the weave records only this url
30
30
  .TP
31
31
  \fB\-\-rom\-name\fR \fI<ROM_NAME>\fR
32
32
  Expected source ROM file name to show and use for output naming; a mismatch is advisory
33
33
  .TP
34
34
  \fB\-\-rom\-member\fR \fI<ROM_MEMBER>\fR
35
- Use this exact archive member or disc track as the bundle ROM target
35
+ Use this exact archive member or disc track as the weave ROM target
36
36
  .TP
37
37
  \fB\-\-patch\fR \fI<PATCH>\fR
38
- Patch to list in the bundle. Repeat once per patch, in the order they should be
38
+ Patch to list in the weave. Repeat once per patch, in the order they should be
39
39
  applied.
40
40
 
41
41
  Every \-\-patch\-* flag describes the \-\-patch before it, so metadata for several
@@ -104,7 +104,7 @@ false
104
104
  .RE
105
105
  .TP
106
106
  \fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
107
- Where the preceding \-\-patch can be downloaded from. The local file is still read to build the bundle
107
+ Where the preceding \-\-patch can be downloaded from. The local file is still read to build the weave
108
108
 
109
109
  This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
110
110
 
@@ -130,7 +130,7 @@ auto
130
130
  .RE
131
131
  .TP
132
132
  \fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
133
- Override the preceding \-\-patch input rule: base (the bundle\*(Aqs ROM) or previous (the patch before it). Use auto to inherit the bundle rule
133
+ Override the preceding \-\-patch input rule: base (the weave\*(Aqs ROM) or previous (the patch before it). Use auto to inherit the weave rule
134
134
 
135
135
  This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
136
136
 
@@ -168,7 +168,7 @@ previous
168
168
  .RE
169
169
  .TP
170
170
  \fB\-\-patch\-expect\-in\fR \fI<ALGO=HEX>\fR
171
- Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the bundle\*(Aqs ROM checksums (repeatable, comma\-separable)
171
+ Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the weave\*(Aqs ROM checksums (repeatable, comma\-separable)
172
172
 
173
173
  This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
174
174
 
@@ -181,7 +181,7 @@ Checksum the ROM should have after the preceding \-\-patch runs. Recorded only w
181
181
  Checksum the ROM should have once every patch has run, so users can confirm they got the right result (repeatable, comma\-separable)
182
182
  .TP
183
183
  \fB\-\-output\-name\fR \fI<OUTPUT_NAME>\fR
184
- File name the bundle suggests for the patched ROM
184
+ File name the weave suggests for the patched ROM
185
185
  .TP
186
186
  \fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
187
187
  Whether the patched ROM should keep its copier header: auto, keep, or strip
@@ -199,16 +199,16 @@ auto
199
199
  .RE
200
200
  .TP
201
201
  \fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
202
- Where to write the bundle. Name it rom\-weaver\-bundle.json, or add .gz or .zst to compress it
202
+ Where to write the weave. Name it rom\-weaver\-weave.json, or add .gz or .zst to compress it
203
203
  .TP
204
- \fB\-\-bundle\fR \fI<BUNDLE>\fR
205
- Also pack the bundle and its ROM and patches into one shareable archive, such as release.zip
204
+ \fB\-\-weave\fR \fI<BUNDLE>\fR
205
+ Also pack the weave and its ROM and patches into one shareable archive, such as release.zip
206
206
  .TP
207
- \fB\-\-bundle\-rom\fR \fI<BUNDLE_ROM>\fR
208
- Pack this file into \-\-bundle as the ROM, while \-\-input supplies the checksums and metadata
207
+ \fB\-\-weave\-rom\fR \fI<BUNDLE_ROM>\fR
208
+ Pack this file into \-\-weave as the ROM, while \-\-input supplies the checksums and metadata
209
209
  .TP
210
- \fB\-\-no\-bundle\-rom\fR
211
- Keep the ROM out of \-\-bundle and record only its checksums, so whoever applies the bundle brings their own copy
210
+ \fB\-\-no\-weave\-rom\fR
211
+ Keep the ROM out of \-\-weave and record only its checksums, so whoever applies the weave brings their own copy
212
212
  .TP
213
213
  \fB\-\-checksum\fR \fI<ALGO>\fR
214
214
  Which checksums to record for the ROM (repeatable, comma\-separable) [default: crc32,md5,sha1]
@@ -236,17 +236,17 @@ adler32
236
236
  .RE
237
237
  .TP
238
238
  \fB\-\-from\fR \fI<FILE>\fR
239
- Build the bundle from a hand\-written rom\-weaver\-bundle.json instead of flags.
239
+ Build the weave from a hand\-written rom\-weaver\-weave.json instead of flags.
240
240
  Use \- to read it from stdin.
241
241
 
242
242
  Write the file with local paths and leave the checksums out; they are filled in
243
- from the real files. Get the schema with `rom\-weaver bundle schema` so your
243
+ from the real files. Get the schema with `rom\-weaver weave schema` so your
244
244
  editor can check the file as you write it.
245
245
 
246
246
  Any flag you also pass overrides what the file says.
247
247
  .TP
248
248
  \fB\-\-schema\-ref\fR \fI<URL>\fR
249
- Record this $schema URL in the bundle so editors can validate it. Left out unless asked for
249
+ Record this $schema URL in the weave so editors can validate it. Left out unless asked for
250
250
  .TP
251
251
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
252
252
  How many threads to use at most. auto uses every core; a format may still use fewer
@@ -1,15 +1,15 @@
1
1
  .ie \n(.g .ds Aq \(aq
2
2
  .el .ds Aq '
3
- .TH rom-weaver-bundle-parse 1 "rom-weaver-bundle-parse "
3
+ .TH rom-weaver-weave-parse 1 "rom-weaver-weave-parse "
4
4
  .SH NAME
5
- rom\-weaver\-bundle\-parse \- Read a rom\-weaver\-bundle.json recipe and report what it points at
5
+ rom\-weaver\-weave\-parse \- Read a rom\-weaver\-weave.json recipe and report what it points at
6
6
  .SH SYNOPSIS
7
- \fBrom\-weaver bundle parse\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-jsonl\fR] [\fB\-\-no\-extract\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-j\fR|\fB\-\-threads\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>
7
+ \fBrom\-weaver weave parse\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-jsonl\fR] [\fB\-\-no\-extract\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-j\fR|\fB\-\-threads\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>
8
8
  .SH DESCRIPTION
9
- Read a rom\-weaver\-bundle.json recipe, check that it is valid, and report the
9
+ Read a rom\-weaver\-weave.json recipe, check that it is valid, and report the
10
10
  ROM and patches it points at.
11
11
  .PP
12
- The input can be a plain rom\-weaver\-bundle.json, a compressed one (.gz, .bz2,
12
+ The input can be a plain rom\-weaver\-weave.json, a compressed one (.gz, .bz2,
13
13
  \&.xz, or .zst), or an archive with the recipe at its root alongside the files it
14
14
  names.
15
15
  .PP
@@ -17,17 +17,17 @@ Entries that name a file are looked for in the archive, or next to the recipe.
17
17
  Pass \-\-output to write those files out and get real paths back. Entries that
18
18
  name a url are reported as they are; nothing is downloaded.
19
19
  .PP
20
- To actually run a bundle, use `rom\-weaver patch apply \-\-bundle` instead.
20
+ To actually run a weave, use `rom\-weaver patch apply \-\-weave` instead.
21
21
  .SH OPTIONS
22
22
  .TP
23
23
  \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
24
- Bundle file, or an archive with a bundle at its root
24
+ Weave file, or an archive with a weave at its root
25
25
  .TP
26
26
  \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
27
- Handle only the bundle entries whose file name matches this exact name, prefix, or glob (repeatable)
27
+ Handle only the weave entries whose file name matches this exact name, prefix, or glob (repeatable)
28
28
  .TP
29
29
  \fB\-\-filter\fR \fI<FILTER>\fR
30
- Handle only the bundle\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
30
+ Handle only the weave\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
31
31
  .br
32
32
 
33
33
  .br
@@ -40,10 +40,10 @@ patch
40
40
  .RE
41
41
  .TP
42
42
  \fB\-\-no\-extract\fR
43
- Report what the bundle contains without unpacking any of it
43
+ Report what the weave contains without unpacking any of it
44
44
  .TP
45
45
  \fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
46
- Directory to unpack the bundle\*(Aqs files into. Without it, files packed in an archive are listed but not written out
46
+ Directory to unpack the weave\*(Aqs files into. Without it, files packed in an archive are listed but not written out
47
47
  .TP
48
48
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
49
49
  How many threads to use at most. auto uses every core; a format may still use fewer
@@ -1,20 +1,20 @@
1
1
  .ie \n(.g .ds Aq \(aq
2
2
  .el .ds Aq '
3
- .TH rom-weaver-bundle-schema 1 "rom-weaver-bundle-schema "
3
+ .TH rom-weaver-weave-schema 1 "rom-weaver-weave-schema "
4
4
  .SH NAME
5
- rom\-weaver\-bundle\-schema \- Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
5
+ rom\-weaver\-weave\-schema \- Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
6
6
  .SH SYNOPSIS
7
- \fBrom\-weaver bundle schema\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]
7
+ \fBrom\-weaver weave schema\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]
8
8
  .SH DESCRIPTION
9
- Print the rom\-weaver\-bundle.json JSON Schema to stdout.
9
+ Print the rom\-weaver\-weave.json JSON Schema to stdout.
10
10
  .PP
11
11
  Save it and point your editor at it, and the editor will check and autocomplete
12
- a bundle as you write it:
12
+ a weave as you write it:
13
13
  .PP
14
- rom\-weaver bundle schema > rom\-weaver\-bundle\-v2.schema.json
14
+ rom\-weaver weave schema > rom\-weaver\-weave\-v2.schema.json
15
15
  .PP
16
- Then `bundle create \-\-from <your file>` turns what you wrote into a finished
17
- bundle with the checksums filled in.
16
+ Then `weave create \-\-from <your file>` turns what you wrote into a finished
17
+ weave with the checksums filled in.
18
18
  .SH OPTIONS
19
19
  .TP
20
20
  \fB\-h\fR, \fB\-\-help\fR
@@ -1,12 +1,12 @@
1
1
  .ie \n(.g .ds Aq \(aq
2
2
  .el .ds Aq '
3
- .TH rom-weaver-bundle 1 "rom-weaver-bundle "
3
+ .TH rom-weaver-weave 1 "rom-weaver-weave "
4
4
  .SH NAME
5
- rom\-weaver\-bundle \- Build and read rom\-weaver\-bundle.json patch recipes
5
+ rom\-weaver\-weave \- Build and read rom\-weaver\-weave.json patch recipes
6
6
  .SH SYNOPSIS
7
- \fBrom\-weaver bundle\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>
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
- Build and read rom\-weaver\-bundle.json patch recipes
9
+ Build and read rom\-weaver\-weave.json patch recipes
10
10
  .SH OPTIONS
11
11
  .TP
12
12
  \fB\-h\fR, \fB\-\-help\fR
@@ -71,11 +71,11 @@ Turn colors off
71
71
  Answer yes to every confirmation instead of asking. Does not choose between candidates
72
72
  .SH SUBCOMMANDS
73
73
  .TP
74
- rom\-weaver\-bundle\-create(1)
75
- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
74
+ rom\-weaver\-weave\-create(1)
75
+ Write a rom\-weaver\-weave.json recipe from local ROM and patch files
76
76
  .TP
77
- rom\-weaver\-bundle\-parse(1)
78
- Read a rom\-weaver\-bundle.json recipe and report what it points at
77
+ rom\-weaver\-weave\-parse(1)
78
+ Read a rom\-weaver\-weave.json recipe and report what it points at
79
79
  .TP
80
- rom\-weaver\-bundle\-schema(1)
81
- Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
80
+ rom\-weaver\-weave\-schema(1)
81
+ Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-patch\-apply \- Apply one or more patches to a ROM, in order
6
6
  .SH SYNOPSIS
7
- \fBrom\-weaver patch apply\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-jsonl\fR] [\fB\-\-target\fR] [\fB\-\-filter\fR] [\fB\-\-progress\fR] [\fB\-\-no\-extract\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-\-no\-ignore\fR] [\fB\-\-patch\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-select\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-bundle\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-with\fR] [\fB\-\-no\-color\fR] [\fB\-\-without\fR] [\fB\-\-without\-cheats\fR] [\fB\-y\fR|\fB\-\-yes\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\-\-patch\-input\-check\fR] [\fB\-\-patch\-output\-check\fR] [\fB\-\-default\-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\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-emit\-bundle\fR] [\fB\-\-tui\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
7
+ \fBrom\-weaver patch apply\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-jsonl\fR] [\fB\-\-target\fR] [\fB\-\-filter\fR] [\fB\-\-progress\fR] [\fB\-\-no\-extract\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-\-no\-ignore\fR] [\fB\-\-patch\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-select\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-weave\fR] [\fB\-\-color\fR] [\fB\-\-with\fR] [\fB\-\-no\-color\fR] [\fB\-\-without\fR] [\fB\-\-without\-cheats\fR] [\fB\-y\fR|\fB\-\-yes\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\-\-patch\-input\-check\fR] [\fB\-\-patch\-output\-check\fR] [\fB\-\-default\-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\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-emit\-weave\fR] [\fB\-\-tui\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
8
8
  .SH DESCRIPTION
9
9
  Apply one or more patches to a ROM, in order.
10
10
  .PP
@@ -14,7 +14,7 @@ spelling `rom\-weaver weave` runs the same command.
14
14
  Repeat \-\-patch once per patch. They run left to right, each one on the result
15
15
  of the last. \-\-input takes a plain ROM, an archive, or a single\-payload
16
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
17
+ rom\-weaver\-weave.json that already names the ROM, the patches, and the
18
18
  output.
19
19
  .PP
20
20
  When \-\-output names the selected ROM leaf\*(Aqs extension, rom\-weaver writes a
@@ -43,7 +43,7 @@ Print help (see a summary with \*(Aq\-h\*(Aq)
43
43
  .SH BASIC
44
44
  .TP
45
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
46
+ ROM to patch. May be an archive, a disc sheet (.cue/.gdi), or a weave
47
47
  .TP
48
48
  \fB\-\-patch\fR \fI<PATCHES>\fR
49
49
  Patch to apply. Repeat once per patch; they run in the order given, each on the
@@ -146,7 +146,7 @@ very\-high
146
146
  .IP \(bu 2
147
147
  max
148
148
  .RE
149
- .SH ARCHIVE/BUNDLE
149
+ .SH ARCHIVE/WEAVE
150
150
  .TP
151
151
  \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
152
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
@@ -176,22 +176,22 @@ Also consider files normally skipped inside archives: readmes, images, checksum
176
176
  \fB\-\-patch\-select\fR \fI<GLOB>\fR
177
177
  Pick which file to use inside the \-\-patch archive before it. Repeatable, one per \-\-patch; falls back to \-\-select
178
178
  .TP
179
- \fB\-\-bundle\fR \fI<BUNDLE>\fR
180
- Follow a rom\-weaver\-bundle.json recipe, which lists the patches, their order,
179
+ \fB\-\-weave\fR \fI<BUNDLE>\fR
180
+ Follow a rom\-weaver\-weave.json recipe, which lists the patches, their order,
181
181
  and the expected checksums. Takes a file path or an http(s) URL.
182
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
183
+ You can usually skip this flag. A weave is picked up automatically when
184
+ \-\-input is a rom\-weaver\-weave.json (optionally .gz, .bz2, .xz, or .zst), or an
185
185
  archive with one at its root, and you passed no \-\-patch of your own.
186
186
  .TP
187
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)
188
+ Turn on a weave patch the weave leaves off by default, matched by name or file name (repeatable)
189
189
  .TP
190
190
  \fB\-\-without\fR \fI<GLOB>\fR
191
- Turn off a bundle patch, matched by name or file name (repeatable)
191
+ Turn off a weave patch, matched by name or file name (repeatable)
192
192
  .TP
193
193
  \fB\-\-without\-cheats\fR
194
- Ignore every cheat the bundle records and run only its patch chain
194
+ Ignore every cheat the weave records and run only its patch chain
195
195
  .SH COMPATIBILITY
196
196
  .TP
197
197
  \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
@@ -381,11 +381,11 @@ Console the \-\-code values are for (nes, snes, genesis, 32x, sms, gamegear, sg1
381
381
  \fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
382
382
  Cheat scheme: auto, game\-genie, gameshark/par, xploder, pro\-action\-rocky, gold\-finger, game\-shark\-v1[\-raw], or action\-replay\-v3[\-raw]
383
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
384
+ \fB\-\-emit\-weave\fR \fI<PATH>\fR
385
+ Also write a rom\-weaver\-weave.json recording this run, so someone else can repeat it
386
386
  .TP
387
387
  \fB\-\-tui\fR
388
- Ask for each patch\*(Aqs name, version, and author, then apply and write a bundle. Needs a terminal
388
+ Ask for each patch\*(Aqs name, version, and author, then apply and write a weave. Needs a terminal
389
389
  .SH CHEATS
390
390
  .TP
391
391
  \fB\-\-cheat\fR \fI<ID_OR_DESCRIPTION>\fR
@@ -132,7 +132,7 @@ How many threads to use at most. auto uses every core; a format may still use fe
132
132
  .TP
133
133
  \fB\-h\fR, \fB\-\-help\fR
134
134
  Print help (see a summary with \*(Aq\-h\*(Aq)
135
- .SH ARCHIVE/BUNDLE
135
+ .SH ARCHIVE/WEAVE
136
136
  .TP
137
137
  \fB\-\-patch\-select\fR \fI<GLOB>\fR
138
138
  Pick which file to use inside the \-\-patch archive before it. Repeatable, one per \-\-patch; falls back to \-\-select
@@ -7,7 +7,7 @@ rom\-weaver\-setup \- Install the offline identify and cheat databases
7
7
  \fBrom\-weaver setup\fR [\fB\-\-database\-dir\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-from\fR] [\fB\-\-json\fR] [\fB\-\-force\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]
8
8
  .SH DESCRIPTION
9
9
  Install the identify database this build\*(Aqs `identify` command searches, plus
10
- the cheat shards that `cheat` and bundle cheat steps read.
10
+ the cheat shards that `cheat` and weave cheat steps read.
11
11
  .PP
12
12
  Run it once after installing rom\-weaver by a method that ships only the
13
13
  executable, such as `cargo binstall` or `cargo install`. The Homebrew, scoop,