Help:Tools/rstb: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
(Created page with "Category:Tools Category:Tools (RSTB) {{Tool infobox | name = rstb | authors = leoetlino | source = https://github.com/leoetlino/rstb | license = GPLv3 | written_in = P...")
 
imported>Leoetlino
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 5: Line 5:
| authors = leoetlino
| authors = leoetlino
| source = https://github.com/leoetlino/rstb
| source = https://github.com/leoetlino/rstb
| license = GPLv3
| license = GPLv2+
| written_in = Python
| written_in = Python
| win_only =  
| win_only =  
Line 13: Line 13:


== Setup ==
== Setup ==
# Install the rstb package.{{Install py package help|package=rstb}}
Install the rstb package.{{Install py package help|package=rstb}}
 
== Usage ==
This tool automatically decompresses Yaz0-compressed RSTBs, and re-compresses after editing if the file extension starts with an s. This means that '''you do not need to compress or decompress files manually'''.
 
'''Important''': You must pass <code>--be</code> if you are dealing with a big endian RSTB (Wii U version).
<code>path_to_rstb</code> is a path to the [[ResourceSizeTable.product.rsizetable]] file. <code>RESOURCE_NAME</code> is a [[canonical resource path]].
* To '''get''' a resource size: <code>rstbtool [--be] path_to_rstb get RESOURCE_NAME</code> {{ch}}
* To '''set''' a resource size: <code>rstbtool [--be] path_to_rstb set RESOURCE_NAME NEW_SIZE</code> {{ch}}
** NEW_SIZE can be an integer (hex or decimal) or a real file path (in which case rstb will automatically calculate the resource size).
* To '''add''' a resource size: <code>rstbtool [--be] path_to_rstb add RESOURCE_NAME NEW_SIZE</code> {{ch}}
* To '''delete''' a resource size: <code>rstbtool [--be] path_to_rstb del RESOURCE_NAME</code> {{ch}}


== Known issues ==
== Known issues ==
* '''Size calculation for complex resources''': rstb is currently unable to calculate file sizes for complex resource classes (see [[Resource system]] for more information). The CLI will suggest deleting entries if it detects that this is the case.
* '''Size calculation for complex resources''': rstb is currently unable to calculate file sizes for complex resource classes (see [[Resource system#Resource size calculation]] for more information). The CLI will suggest deleting entries if it detects that this is the case.

Latest revision as of 18:29, 1 February 2019

rstb
Author(s) leoetlino
Source code https://github.com/leoetlino/rstb
License GPLv2+
Written in Python
Platform support Cross-platform

rstb (rstbtool for the CLI) is a tool for manipulating Breath of the Wild's resource size table (RSTB).

Setup

Install the rstb package.[CLI help]

Usage

This tool automatically decompresses Yaz0-compressed RSTBs, and re-compresses after editing if the file extension starts with an s. This means that you do not need to compress or decompress files manually.

Important: You must pass --be if you are dealing with a big endian RSTB (Wii U version). path_to_rstb is a path to the ResourceSizeTable.product.rsizetable file. RESOURCE_NAME is a canonical resource path.

  • To get a resource size: rstbtool [--be] path_to_rstb get RESOURCE_NAME [help]
  • To set a resource size: rstbtool [--be] path_to_rstb set RESOURCE_NAME NEW_SIZE [help]
    • NEW_SIZE can be an integer (hex or decimal) or a real file path (in which case rstb will automatically calculate the resource size).
  • To add a resource size: rstbtool [--be] path_to_rstb add RESOURCE_NAME NEW_SIZE [help]
  • To delete a resource size: rstbtool [--be] path_to_rstb del RESOURCE_NAME [help]

Known issues

  • Size calculation for complex resources: rstb is currently unable to calculate file sizes for complex resource classes (see Resource system for more information). The CLI will suggest deleting entries if it detects that this is the case.