@rom-weaver/cli 0.15.0 → 0.16.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 +39 -22
- package/docs/completions/_rom-weaver +1242 -644
- package/docs/completions/rom-weaver.bash +690 -109
- package/docs/completions/rom-weaver.elv +973 -576
- package/docs/completions/rom-weaver.fish +841 -536
- package/docs/completions/rom-weaver.ps1 +1006 -588
- package/docs/man/rom-weaver-bundle-create.1 +55 -8
- package/docs/man/rom-weaver-bundle-parse.1 +15 -6
- package/docs/man/rom-weaver-bundle-schema.1 +16 -7
- package/docs/man/rom-weaver-bundle.1 +15 -6
- package/docs/man/rom-weaver-cheat.1 +107 -0
- package/docs/man/rom-weaver-checksum.1 +21 -6
- package/docs/man/rom-weaver-completions.1 +15 -6
- package/docs/man/rom-weaver-compress.1 +23 -11
- package/docs/man/rom-weaver-extract.1 +23 -8
- package/docs/man/rom-weaver-formats.1 +15 -6
- package/docs/man/rom-weaver-identify-database-import-redump.1 +15 -6
- package/docs/man/rom-weaver-identify-database-install-all.1 +15 -6
- package/docs/man/rom-weaver-identify-database-install-group.1 +15 -6
- package/docs/man/rom-weaver-identify-database-install.1 +15 -6
- package/docs/man/rom-weaver-identify-database-list.1 +15 -6
- package/docs/man/rom-weaver-identify-database-path.1 +15 -6
- package/docs/man/rom-weaver-identify-database-remove.1 +15 -6
- package/docs/man/rom-weaver-identify-database-status.1 +15 -6
- package/docs/man/rom-weaver-identify-database-update.1 +15 -6
- package/docs/man/rom-weaver-identify-database.1 +15 -6
- package/docs/man/rom-weaver-identify.1 +27 -6
- package/docs/man/rom-weaver-man.1 +15 -6
- package/docs/man/rom-weaver-patch-apply.1 +64 -15
- package/docs/man/rom-weaver-patch-create.1 +33 -8
- package/docs/man/rom-weaver-patch-validate.1 +35 -7
- package/docs/man/rom-weaver-patch.1 +15 -6
- package/docs/man/rom-weaver-probe.1 +18 -6
- package/docs/man/rom-weaver-save-export-schema.1 +80 -0
- package/docs/man/rom-weaver-save-get.1 +83 -0
- package/docs/man/rom-weaver-save-identify.1 +80 -0
- package/docs/man/rom-weaver-save-inspect.1 +80 -0
- package/docs/man/rom-weaver-save-set.1 +89 -0
- package/docs/man/rom-weaver-save.1 +87 -0
- package/docs/man/rom-weaver-setup.1 +18 -6
- package/docs/man/rom-weaver-tools-ppf-undo.1 +16 -7
- package/docs/man/rom-weaver-tools.1 +15 -6
- package/docs/man/rom-weaver-trim.1 +24 -15
- package/docs/man/rom-weaver-weave.1 +64 -15
- package/docs/man/rom-weaver.1 +23 -8
- package/package.json +20 -13
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-get 1 "rom-weaver-save-get "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-get \- Read one field from a supported game save
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save get\fR [\fB\-\-game\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-rom\-sha1\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] <\fISAVE\fR> <\fIFIELD\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Read one field from a supported game save
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-game\fR \fI<GAME_ID>\fR
|
|
13
|
+
Force a game id instead of detecting one
|
|
14
|
+
.TP
|
|
15
|
+
\fB\-\-rom\-sha1\fR \fI<SHA1>\fR
|
|
16
|
+
SHA\-1 of the matching ROM, used to pick a game
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
19
|
+
Print help
|
|
20
|
+
.TP
|
|
21
|
+
<\fISAVE\fR>
|
|
22
|
+
Save file to read
|
|
23
|
+
.TP
|
|
24
|
+
<\fIFIELD\fR>
|
|
25
|
+
Field id to read, such as trainer.money
|
|
26
|
+
.SH "GLOBAL OPTIONS"
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
29
|
+
Plan the command without changing files or downloading data
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-json\fR
|
|
32
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-jsonl\fR
|
|
35
|
+
Stream JSON events, including progress, one object per line
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-progress\fR
|
|
38
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-no\-progress\fR
|
|
41
|
+
Hide progress
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
44
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
45
|
+
.br
|
|
46
|
+
|
|
47
|
+
.br
|
|
48
|
+
\fIPossible values:\fR
|
|
49
|
+
.RS 14
|
|
50
|
+
.IP \(bu 2
|
|
51
|
+
off
|
|
52
|
+
.IP \(bu 2
|
|
53
|
+
error
|
|
54
|
+
.IP \(bu 2
|
|
55
|
+
warn
|
|
56
|
+
.IP \(bu 2
|
|
57
|
+
info
|
|
58
|
+
.IP \(bu 2
|
|
59
|
+
debug
|
|
60
|
+
.IP \(bu 2
|
|
61
|
+
trace
|
|
62
|
+
.RE
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
65
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-debug\fR
|
|
68
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
71
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-dep\-trace\fR
|
|
74
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-color\fR
|
|
77
|
+
Keep colors even when output is piped
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-no\-color\fR
|
|
80
|
+
Turn colors off
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
83
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-identify 1 "rom-weaver-save-identify "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-identify \- Identify a supported game save without changing it
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save identify\fR [\fB\-\-game\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-rom\-sha1\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] <\fISAVE\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Identify a supported game save without changing it
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-game\fR \fI<GAME_ID>\fR
|
|
13
|
+
Force a game id instead of detecting one
|
|
14
|
+
.TP
|
|
15
|
+
\fB\-\-rom\-sha1\fR \fI<SHA1>\fR
|
|
16
|
+
SHA\-1 of the matching ROM, used to pick a game
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
19
|
+
Print help
|
|
20
|
+
.TP
|
|
21
|
+
<\fISAVE\fR>
|
|
22
|
+
Save file to read
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
26
|
+
Plan the command without changing files or downloading data
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-json\fR
|
|
29
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-jsonl\fR
|
|
32
|
+
Stream JSON events, including progress, one object per line
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-progress\fR
|
|
35
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-progress\fR
|
|
38
|
+
Hide progress
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
41
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
42
|
+
.br
|
|
43
|
+
|
|
44
|
+
.br
|
|
45
|
+
\fIPossible values:\fR
|
|
46
|
+
.RS 14
|
|
47
|
+
.IP \(bu 2
|
|
48
|
+
off
|
|
49
|
+
.IP \(bu 2
|
|
50
|
+
error
|
|
51
|
+
.IP \(bu 2
|
|
52
|
+
warn
|
|
53
|
+
.IP \(bu 2
|
|
54
|
+
info
|
|
55
|
+
.IP \(bu 2
|
|
56
|
+
debug
|
|
57
|
+
.IP \(bu 2
|
|
58
|
+
trace
|
|
59
|
+
.RE
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
62
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-debug\fR
|
|
65
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
68
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-dep\-trace\fR
|
|
71
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-color\fR
|
|
74
|
+
Keep colors even when output is piped
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-no\-color\fR
|
|
77
|
+
Turn colors off
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
80
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-inspect 1 "rom-weaver-save-inspect "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-inspect \- Show the sections and fields in a supported game save
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save inspect\fR [\fB\-\-game\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-rom\-sha1\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] <\fISAVE\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Show the sections and fields in a supported game save
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-game\fR \fI<GAME_ID>\fR
|
|
13
|
+
Force a game id instead of detecting one
|
|
14
|
+
.TP
|
|
15
|
+
\fB\-\-rom\-sha1\fR \fI<SHA1>\fR
|
|
16
|
+
SHA\-1 of the matching ROM, used to pick a game
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
19
|
+
Print help
|
|
20
|
+
.TP
|
|
21
|
+
<\fISAVE\fR>
|
|
22
|
+
Save file to read
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
26
|
+
Plan the command without changing files or downloading data
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-json\fR
|
|
29
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-jsonl\fR
|
|
32
|
+
Stream JSON events, including progress, one object per line
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-progress\fR
|
|
35
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-progress\fR
|
|
38
|
+
Hide progress
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
41
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
42
|
+
.br
|
|
43
|
+
|
|
44
|
+
.br
|
|
45
|
+
\fIPossible values:\fR
|
|
46
|
+
.RS 14
|
|
47
|
+
.IP \(bu 2
|
|
48
|
+
off
|
|
49
|
+
.IP \(bu 2
|
|
50
|
+
error
|
|
51
|
+
.IP \(bu 2
|
|
52
|
+
warn
|
|
53
|
+
.IP \(bu 2
|
|
54
|
+
info
|
|
55
|
+
.IP \(bu 2
|
|
56
|
+
debug
|
|
57
|
+
.IP \(bu 2
|
|
58
|
+
trace
|
|
59
|
+
.RE
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
62
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-debug\fR
|
|
65
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
68
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-dep\-trace\fR
|
|
71
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-color\fR
|
|
74
|
+
Keep colors even when output is piped
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-no\-color\fR
|
|
77
|
+
Turn colors off
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
80
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-set 1 "rom-weaver-save-set "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-set \- Write validated field changes to a new game save
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save set\fR [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-game\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-rom\-sha1\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-progress\fR] [\fB\-\-force\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] <\fISAVE\fR> <\fIFIELD=VALUE\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Write validated field changes to a new game save
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
|
|
13
|
+
Output path; \- writes one completed binary file to stdout
|
|
14
|
+
.TP
|
|
15
|
+
\fB\-\-game\fR \fI<GAME_ID>\fR
|
|
16
|
+
Force a game id instead of detecting one
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-rom\-sha1\fR \fI<SHA1>\fR
|
|
19
|
+
SHA\-1 of the matching ROM, used to pick a game
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
22
|
+
Validate and preview every change without writing a file
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-force\fR
|
|
25
|
+
Overwrite an explicit output path if it already exists
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
28
|
+
Print help
|
|
29
|
+
.TP
|
|
30
|
+
<\fISAVE\fR>
|
|
31
|
+
Save file to read
|
|
32
|
+
.TP
|
|
33
|
+
<\fIFIELD=VALUE\fR>
|
|
34
|
+
Field assignments to apply, such as trainer.money=999999
|
|
35
|
+
.SH "GLOBAL OPTIONS"
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-json\fR
|
|
38
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-jsonl\fR
|
|
41
|
+
Stream JSON events, including progress, one object per line
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-progress\fR
|
|
44
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-no\-progress\fR
|
|
47
|
+
Hide progress
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
50
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
51
|
+
.br
|
|
52
|
+
|
|
53
|
+
.br
|
|
54
|
+
\fIPossible values:\fR
|
|
55
|
+
.RS 14
|
|
56
|
+
.IP \(bu 2
|
|
57
|
+
off
|
|
58
|
+
.IP \(bu 2
|
|
59
|
+
error
|
|
60
|
+
.IP \(bu 2
|
|
61
|
+
warn
|
|
62
|
+
.IP \(bu 2
|
|
63
|
+
info
|
|
64
|
+
.IP \(bu 2
|
|
65
|
+
debug
|
|
66
|
+
.IP \(bu 2
|
|
67
|
+
trace
|
|
68
|
+
.RE
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
71
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-debug\fR
|
|
74
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
77
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-dep\-trace\fR
|
|
80
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-color\fR
|
|
83
|
+
Keep colors even when output is piped
|
|
84
|
+
.TP
|
|
85
|
+
\fB\-\-no\-color\fR
|
|
86
|
+
Turn colors off
|
|
87
|
+
.TP
|
|
88
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
89
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save 1 "rom-weaver-save "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save \- Inspect and edit supported persistent game saves
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save\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
|
+
.SH DESCRIPTION
|
|
9
|
+
Inspect and edit supported persistent game saves
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
13
|
+
Print help
|
|
14
|
+
.SH "GLOBAL OPTIONS"
|
|
15
|
+
.TP
|
|
16
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
17
|
+
Plan the command without changing files or downloading data
|
|
18
|
+
.TP
|
|
19
|
+
\fB\-\-json\fR
|
|
20
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
21
|
+
.TP
|
|
22
|
+
\fB\-\-jsonl\fR
|
|
23
|
+
Stream JSON events, including progress, one object per line
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-progress\fR
|
|
26
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-no\-progress\fR
|
|
29
|
+
Hide progress
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
32
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
33
|
+
.br
|
|
34
|
+
|
|
35
|
+
.br
|
|
36
|
+
\fIPossible values:\fR
|
|
37
|
+
.RS 14
|
|
38
|
+
.IP \(bu 2
|
|
39
|
+
off
|
|
40
|
+
.IP \(bu 2
|
|
41
|
+
error
|
|
42
|
+
.IP \(bu 2
|
|
43
|
+
warn
|
|
44
|
+
.IP \(bu 2
|
|
45
|
+
info
|
|
46
|
+
.IP \(bu 2
|
|
47
|
+
debug
|
|
48
|
+
.IP \(bu 2
|
|
49
|
+
trace
|
|
50
|
+
.RE
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
53
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-debug\fR
|
|
56
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
59
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-dep\-trace\fR
|
|
62
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-color\fR
|
|
65
|
+
Keep colors even when output is piped
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-no\-color\fR
|
|
68
|
+
Turn colors off
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
71
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
72
|
+
.SH SUBCOMMANDS
|
|
73
|
+
.TP
|
|
74
|
+
rom\-weaver\-save\-identify(1)
|
|
75
|
+
Identify a supported game save without changing it
|
|
76
|
+
.TP
|
|
77
|
+
rom\-weaver\-save\-inspect(1)
|
|
78
|
+
Show the sections and fields in a supported game save
|
|
79
|
+
.TP
|
|
80
|
+
rom\-weaver\-save\-get(1)
|
|
81
|
+
Read one field from a supported game save
|
|
82
|
+
.TP
|
|
83
|
+
rom\-weaver\-save\-set(1)
|
|
84
|
+
Write validated field changes to a new game save
|
|
85
|
+
.TP
|
|
86
|
+
rom\-weaver\-save\-export\-schema(1)
|
|
87
|
+
Print the generic field schema for a supported game save
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-setup \- Install the offline identify database
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver setup\fR [\fB\-\-database\-dir\fR] [\fB\-\-json\fR] [\fB\-\-force\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\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 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.
|
|
10
10
|
.PP
|
|
@@ -20,6 +20,9 @@ data directory; `identify database install\-group` adds the optional packs.
|
|
|
20
20
|
\fB\-\-database\-dir\fR \fI<DIR>\fR
|
|
21
21
|
Install into this directory instead of the per\-user data directory
|
|
22
22
|
.TP
|
|
23
|
+
\fB\-\-from\fR \fI<ARCHIVE>\fR
|
|
24
|
+
Local rom\-weaver\-identify\-data.tar.br; omit to download the archive for this version
|
|
25
|
+
.TP
|
|
23
26
|
\fB\-\-force\fR
|
|
24
27
|
Download the database again even when it is already installed
|
|
25
28
|
.TP
|
|
@@ -27,17 +30,23 @@ Download the database again even when it is already installed
|
|
|
27
30
|
Print help (see a summary with \*(Aq\-h\*(Aq)
|
|
28
31
|
.SH "GLOBAL OPTIONS"
|
|
29
32
|
.TP
|
|
33
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
34
|
+
Plan the command without changing files or downloading data
|
|
35
|
+
.TP
|
|
30
36
|
\fB\-\-json\fR
|
|
31
|
-
Print one JSON
|
|
37
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-jsonl\fR
|
|
40
|
+
Stream JSON events, including progress, one object per line
|
|
32
41
|
.TP
|
|
33
42
|
\fB\-\-progress\fR
|
|
34
|
-
Show progress
|
|
43
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
35
44
|
.TP
|
|
36
45
|
\fB\-\-no\-progress\fR
|
|
37
46
|
Hide progress
|
|
38
47
|
.TP
|
|
39
48
|
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
40
|
-
How much rom\-weaver logs to stderr. Separate from the normal output [default:
|
|
49
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
41
50
|
.br
|
|
42
51
|
|
|
43
52
|
.br
|
|
@@ -58,10 +67,13 @@ trace
|
|
|
58
67
|
.RE
|
|
59
68
|
.TP
|
|
60
69
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
61
|
-
|
|
70
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-debug\fR
|
|
73
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
62
74
|
.TP
|
|
63
75
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
64
|
-
|
|
76
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
65
77
|
.TP
|
|
66
78
|
\fB\-\-dep\-trace\fR
|
|
67
79
|
Also log trace output from bundled libraries (for bug reports)
|
|
@@ -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\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\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\-\-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>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Undo a PPF3 patch, turning a patched ROM back into the original.
|
|
10
10
|
.PP
|
|
@@ -19,23 +19,29 @@ The already\-patched ROM to undo
|
|
|
19
19
|
The PPF3 patch that was applied. It must carry undo data
|
|
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
24
|
\fB\-h\fR, \fB\-\-help\fR
|
|
25
25
|
Print help (see a summary with \*(Aq\-h\*(Aq)
|
|
26
26
|
.SH "GLOBAL OPTIONS"
|
|
27
27
|
.TP
|
|
28
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
29
|
+
Plan the command without changing files or downloading data
|
|
30
|
+
.TP
|
|
28
31
|
\fB\-\-json\fR
|
|
29
|
-
Print one JSON
|
|
32
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-jsonl\fR
|
|
35
|
+
Stream JSON events, including progress, one object per line
|
|
30
36
|
.TP
|
|
31
37
|
\fB\-\-progress\fR
|
|
32
|
-
Show progress
|
|
38
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
33
39
|
.TP
|
|
34
40
|
\fB\-\-no\-progress\fR
|
|
35
41
|
Hide progress
|
|
36
42
|
.TP
|
|
37
43
|
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
38
|
-
How much rom\-weaver logs to stderr. Separate from the normal output [default:
|
|
44
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
39
45
|
.br
|
|
40
46
|
|
|
41
47
|
.br
|
|
@@ -56,10 +62,13 @@ trace
|
|
|
56
62
|
.RE
|
|
57
63
|
.TP
|
|
58
64
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
59
|
-
|
|
65
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-debug\fR
|
|
68
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
60
69
|
.TP
|
|
61
70
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
62
|
-
|
|
71
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
63
72
|
.TP
|
|
64
73
|
\fB\-\-dep\-trace\fR
|
|
65
74
|
Also log trace output from bundled libraries (for bug reports)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-tools \- One\-off recovery tools
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver tools\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\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 tools\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
9
|
One\-off recovery tools
|
|
10
10
|
.SH OPTIONS
|
|
@@ -13,17 +13,23 @@ One\-off recovery tools
|
|
|
13
13
|
Print help
|
|
14
14
|
.SH "GLOBAL OPTIONS"
|
|
15
15
|
.TP
|
|
16
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
17
|
+
Plan the command without changing files or downloading data
|
|
18
|
+
.TP
|
|
16
19
|
\fB\-\-json\fR
|
|
17
|
-
Print one JSON
|
|
20
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
21
|
+
.TP
|
|
22
|
+
\fB\-\-jsonl\fR
|
|
23
|
+
Stream JSON events, including progress, one object per line
|
|
18
24
|
.TP
|
|
19
25
|
\fB\-\-progress\fR
|
|
20
|
-
Show progress
|
|
26
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
21
27
|
.TP
|
|
22
28
|
\fB\-\-no\-progress\fR
|
|
23
29
|
Hide progress
|
|
24
30
|
.TP
|
|
25
31
|
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
26
|
-
How much rom\-weaver logs to stderr. Separate from the normal output [default:
|
|
32
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
27
33
|
.br
|
|
28
34
|
|
|
29
35
|
.br
|
|
@@ -44,10 +50,13 @@ trace
|
|
|
44
50
|
.RE
|
|
45
51
|
.TP
|
|
46
52
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
47
|
-
|
|
53
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-debug\fR
|
|
56
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
48
57
|
.TP
|
|
49
58
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
50
|
-
|
|
59
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
51
60
|
.TP
|
|
52
61
|
\fB\-\-dep\-trace\fR
|
|
53
62
|
Also log trace output from bundled libraries (for bug reports)
|