Help:Tools/aamp: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
(whoops. GPLv3 -> GPLv2+)
imported>Leoetlino
No edit summary
Line 16: Line 16:


== Usage ==
== Usage ==
* <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code>
* To convert an AAMP file to a human readable format (YML): <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code> {{ch}}
* <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code>
* To convert back to binary format (AAMP): <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code> {{ch}}
* or <code>aamp INPUT_FILE OUTPUT_FILE</code> to convert from AAMP to YAML or vice versa
* or alternatively, the same command can be used to convert from AAMP to YAML and vice versa: <code>aamp INPUT_FILE OUTPUT_FILE</code> {{ch}}


== Known issues ==
== Known issues ==
* '''Incomplete parameter type support''': Esoteric parameter types (buffers) are not fully supported: currently the tool can display files that use buffers correctly but cannot convert them back to AAMP.
* '''Incomplete parameter type support''': Esoteric parameter types (buffers) are not fully supported: currently the tool can display files that use buffers correctly but cannot convert them back to AAMP.

Revision as of 18:22, 1 February 2019

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

aamp is an AAMP tool. It can convert documents from AAMP to a human readable format (YAML) and vice versa. It is a newer tool that was written based on analysis of the official AAMP code in the executable.

Setup

Install the aamp package. [CLI help]

Usage

  • To convert an AAMP file to a human readable format (YML): aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml [help]
  • To convert back to binary format (AAMP): yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist [help]
  • or alternatively, the same command can be used to convert from AAMP to YAML and vice versa: aamp INPUT_FILE OUTPUT_FILE [help]

Known issues

  • Incomplete parameter type support: Esoteric parameter types (buffers) are not fully supported: currently the tool can display files that use buffers correctly but cannot convert them back to AAMP.