Help:Tools/aamp - Revision history

imported>Leoetlino at 11:25, 7 April 2019

2019-04-07T11:25:19Z

← Older revision		Revision as of 11:25, 7 April 2019
Line 16:		Line 16:

	== Usage ==		== Usage ==
	{{~~CLI tool~~\|name=aamp}}		{{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:		Convert from AAMP to text and vice versa with the <code>aamp</code> command:

imported>Leoetlino: /* Usage */ simplify, add examples

2019-04-07T11:10:15Z

Usage: simplify, add examples

← Older revision		Revision as of 11:10, 7 April 2019
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.

imported>Leoetlino at 18:26, 1 February 2019

2019-02-01T18:26:53Z

← Older revision		Revision as of 18:26, 1 February 2019
Line 16:		Line 16:

	== Usage ==		== Usage ==
	* To convert an AAMP file to ~~a human readable format~~ (YML): <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code> {{ch}}		* To '''convert an AAMP file to text''' (YML): <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code> {{ch}}
	* To convert back to binary format (AAMP): <code>yml_to_aamp INPUT_FILE.yml OUTPUT_FILE.bgparamlist</code> {{ch}}		* 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}}		* 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.

imported>Leoetlino at 18:22, 1 February 2019

2019-02-01T18:22:33Z

← Older revision		Revision as of 18:22, 1 February 2019
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.

imported>Leoetlino: whoops. GPLv3 -> GPLv2+

2018-10-21T14:55:27Z

whoops. GPLv3 -> GPLv2+

← Older revision		Revision as of 14:55, 21 October 2018
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 =

imported>Leoetlino at 19:25, 15 October 2018

2018-10-15T19:25:34Z

← Older revision		Revision as of 19:25, 15 October 2018
Line 16:		Line 16:

	== Usage ==		== Usage ==
	~~Convert AAMPs 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>

imported>Leoetlino at 18:53, 15 October 2018

2018-10-15T18:53:41Z

← Older revision		Revision as of 18:53, 15 October 2018
Line 16:		Line 16:

	== Usage ==		== Usage ==
	Convert ~~them~~ to an editable format (and back) with:		Convert AAMPs 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>

imported>Leoetlino: /* Usage */

2018-10-15T18:53:26Z

Usage

← Older revision		Revision as of 18:53, 15 October 2018
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.

imported>Leoetlino at 18:51, 15 October 2018

2018-10-15T18:51:54Z

← Older revision		Revision as of 18:51, 15 October 2018
Line 14:		Line 14:
	== 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 ==
			* <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</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

	== 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.

imported>Leoetlino: /* Setup */

2018-10-15T16:27:58Z

Setup

← Older revision		Revision as of 16:27, 15 October 2018
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}}

	== 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.