Help:Tools/rstb: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
No edit summary
imported>Leoetlino
Line 17: Line 17:
== Usage ==
== Usage ==
'''Important''': You must pass <code>--be</code> if you are dealing with a big endian RSTB (Wii U version).
'''Important''': You must pass <code>--be</code> if you are dealing with a big endian RSTB (Wii U version).
path_to_rstb is a path to the [[ResourceSizeTable.product.rsizetable]] file.
<code>path_to_rstb</code> is a path to the [[ResourceSizeTable.product.rsizetable]] file. <code>RESOURCE_NAME</code> is a [[canonical resource path]].
* '''Get''' a resource size: <code>rstbtool [--be] path_to_rstb get RESOURCE_NAME</code>
* '''Get''' a resource size: <code>rstbtool [--be] path_to_rstb get RESOURCE_NAME</code>
* '''Set''' a resource size: <code>rstbtool [--be] path_to_rstb set RESOURCE_NAME NEW_SIZE</code>
* '''Set''' a resource size: <code>rstbtool [--be] path_to_rstb set RESOURCE_NAME NEW_SIZE</code>

Revision as of 19:04, 15 October 2018

rstb
Author(s) leoetlino
Source code https://github.com/leoetlino/rstb
License GPLv3
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

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.

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

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.