Help:Tools/aamp: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
No edit summary
imported>Leoetlino
Line 16: Line 16:


== Usage ==
== Usage ==
Convert them to an editable format (and back) with:
* <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code>
* <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code>
* <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code>
* <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code>
* or <code>aamp INPUT_FILE OUTPUT_FILE</code> to convert from AAMP to YAML or vice versa  
* or <code>aamp INPUT_FILE OUTPUT_FILE</code> to convert from AAMP to YAML or vice versa


== 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:53, 15 October 2018

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

Convert them to an editable format (and back) with:

  • aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml
  • yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist
  • or aamp INPUT_FILE OUTPUT_FILE to convert from AAMP to YAML or vice versa

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.