diff options
| author | Rangi <remy.oukaour+rangi42@gmail.com> | 2022-03-12 22:50:42 -0500 |
|---|---|---|
| committer | Rangi <remy.oukaour+rangi42@gmail.com> | 2022-03-12 22:50:42 -0500 |
| commit | 732acf1d4f85b82ed20a69e66224b89db9a06f3f (patch) | |
| tree | 50d60af5012d553feefb0b94aa59ec2baf906a8b /docs | |
| parent | f33a04193092e3df8c9b1ac4f560018b95925f61 (diff) | |
Allow `{patch offset length}` (necessary for pokegold)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vc_patch.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/vc_patch.md b/docs/vc_patch.md index dde8dd680..7ed0ec233 100644 --- a/docs/vc_patch.md +++ b/docs/vc_patch.md @@ -88,11 +88,11 @@ Any other characters are output as-is. ## Patch template commands -### <code>{patch[ <i>offset</i>]}</code> +### <code>{patch[ <i>offset</i>[ <i>length</i>]]}</code> -Outputs the bytes of the current patch as a value series, or as a hexadecimal number if there is only one byte. The bytes are found between the current patch label, and the label which is the current patch label plus "`_End`". An optional argument is an *offset* to add to the current patch label before gathering the contents between it and the end label. +Outputs the bytes of the current patch as a value series, or as a hexadecimal number if there is only one byte. The bytes are found between the current patch label, and the label which is the current patch label plus "`_End`". An optional first argument is an *offset* to add to the current patch label before gathering the contents between it and the end label. An optional second argument is a *length* of bytes to output instead of the length between the start and end labels. -For example, if "`{patch}`" outputs "`a3:ab cd ef`", then "`{patch +1}`" outputs "`a2:cd ef`", and "`{patch +2}`" outputs "`0xef`". +For example, if "`{patch}`" outputs "`a3:ab cd ef`", then "`{patch +1}`" outputs "`a2:cd ef`", and "`{patch +1 1}`" outputs "`0xcd`". Converting the patch template will print a warning if any differences exist between the original and patched ROMs, which are not covered by "`patch`" commands. |