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
(→‎Usage: simplify, add examples)
Line 16: Line 16:


== Usage ==
== Usage ==
* To '''convert an AAMP file to text''' (YML): <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code> {{ch}}
{{CLI tool|name=aamp}}
* To '''convert back to binary''' format (AAMP): <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code> {{ch}}
 
* 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}}
Convert from AAMP to text and vice versa with the <code>aamp</code> command:
<pre>aamp {input file} {output file}</pre>
 
{{ex|text=To convert a binary GeneralParamList ([[bgparamlist]]) file to a text file:
<pre>aamp Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml</pre>
The text file will be written to <code>Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml</code>. Of course, you can use whatever file name you want.
 
To convert a text GeneralParamList back to an AAMP file, assuming you put the text file at <code>Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml</code>:
<pre>aamp Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist</pre>
}}


== 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 11:10, 7 April 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

Template:CLI tool

Convert from AAMP to text and vice versa with the aamp command:

aamp {input file} {output file}

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.