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
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/aamp
| source = https://github.com/leoetlino/aamp
| license = GPLv3
| license = GPLv2+
| written_in = Python
| written_in = Python
| win_only =  
| win_only =  
Line 13: Line 13:


== Setup ==
== Setup ==
# Install the <code>aamp</code> package. {{Install py package help|package=aamp}}
Install the <code>aamp</code> package. {{Install py package help|package=aamp}}
 
== Usage ==
{{Tool usage notes|name=aamp|is_cli=1|does_auto_compress=}}
 
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.

Latest revision as of 11:25, 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

aamp is a CLI tool. For help with using the command line, see Help:Using the command line.

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.