Help:Tools/aamp: Difference between revisions
imported>Leoetlino (Created page with "{{Tool infobox | name = aamp | authors = leoetlino | source = https://github.com/leoetlino/aamp | license = GPLv3 | written_in = Python | win_only = }} aamp is an AAMP t...") |
imported>Leoetlino No edit summary |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Tools]] | |||
[[Category:Tools (AAMP)]] | |||
{{Tool infobox | {{Tool infobox | ||
| name = aamp | | name = aamp | ||
| authors = leoetlino | | authors = leoetlino | ||
| source = https://github.com/leoetlino/aamp | | source = https://github.com/leoetlino/aamp | ||
| license = | | license = GPLv2+ | ||
| written_in = Python | | written_in = Python | ||
| win_only = | | win_only = | ||
| Line 11: | Line 13: | ||
== Setup == | == Setup == | ||
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
| 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}
Example
To convert a binary GeneralParamList (bgparamlist) file to a text file:
aamp Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml
The text file will be written to Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml. 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 Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml:
aamp Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist.yml Actor/GeneralParamList/WildHorseCreateTag02.bgparamlist
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.