Difference between revisions of "Mkg3a"

From WikiPrizm
Jump to navigationJump to search
(Added the recent change)
Line 1: Line 1:
{{Incomplete}}
+
mkg3a is a utility to combine icons and a binary into a .g3a file executable on the Prizm. The project page for mkg3a is located [http://www.taricorp.net/projects/mkg3a here]. If you installed mkg3a from source yourself, it should have installed a manpage, which provides all of the below information (run ''man mkg3a'').
 
 
mkg3a is a utility to combine icons and a binary into a .g3a file executable on the Prizm. The project page for mkg3a is located [http://www.taricorp.net/projects/mkg3a here].
 
 
== Download ==
 
== Download ==
You can find the latest build of mkg3a [https://bitbucket.org/tari/mkg3a/downloads here].
+
You can find the latest "release" of mkg3a [https://bitbucket.org/tari/mkg3a/downloads on Bitbucket], or [[User:Tari|Tari]] provides a build of (generally) the latest revision in hg [http://media.taricorp.net/mkg3a.exe].
 
== Usage ==
 
== Usage ==
 
''Note that mkg3a has been changed since the release of PrizmSDK 3.  If the commands listed don't work, please update your mkg3a''
 
''Note that mkg3a has been changed since the release of PrizmSDK 3.  If the commands listed don't work, please update your mkg3a''
  
The command line usage of mkg3a is in the form of ''mkg3a [OPTION] input-file [output-file]''. The input file should be a .bin file, produced by gcc in an ELF format.  The output file should be a .g3a file (this can be omitted).  mkg3a accepts the following options:
+
The command line usage of mkg3a is in the form of ''mkg3a [OPTION] input-file [output-file]''. The input file should be a .bin file, as emitted by gcc/ld with the Prizm linker script.  The output file is a .g3a file, the name of which is auto-generated from your input file name (chop off '.bin', tack on '.g3a') if not specified.  mkg3a accepts the following options:
* '''-i''' ''(uns|sel)'':''file'' - This is used to specify the unselected and selected icons for when the addin is displayed in the Prizm's Main Menu.  These images may be in .bmp or .png format with transparency. For more information about the icons, please refer to [http://www.cemetech.net/forum/viewtopic.php?t=6211 these guidelines]. '''Note:''' These images must be the correct size (64hx92w). mkg3a will not resize the images.
+
* '''-i''' ''(uns|sel)'':''file'' - This is used to specify the unselected and selected icons for when the addin is displayed in the Prizm's Main Menu.  These images may be in .bmp or .png. In both cases, the images must be 24-bit RGB, and BMP files may not be compressed. They must also be the correct size (64 by 92 pixels). For icon design guidelines, refer to the [[Addin_Usability_Guidelines#Icon_Guidelines|Addin Usability Guidelines]].
* '''-n''' ''lc'':''name'' - This is used to set the localized name of the addin.  this is needed because addins contain the name in different languages and for different modes.  If you omit ''lc:'' (such as ''-n name''), then mkg3a will default to the basic name.  You can specify as many language names as you want, however the last one specified for a given language will be used.  The list of language codes are listed below:
+
* '''-n''' ''lc'':''name'' - This is used to set the localized name of the addin.  This is needed because addins contain the name in different languages and for different modes.  If you omit ''lc:'' (such as ''-n name''), then mkg3a will default to the basic name.  You can specify as many language names as you want, however the last one specified for a given language will be used.  The list of language codes are listed below:
 
** ''en'' - English name
 
** ''en'' - English name
 
** ''es'' - Spanish name.
 
** ''es'' - Spanish name.
Line 17: Line 15:
 
** ''zh'' - Chinese name.
 
** ''zh'' - Chinese name.
 
** ''basic'' - (Default for mkg3a) Unlocalized name.
 
** ''basic'' - (Default for mkg3a) Unlocalized name.
** ''internal'' - This is used by the Prizm for an internal use and shouldn't be manually set.
+
** ''internal'' - This appears to be used by the Prizm internally. It should generally not be set manually (mkg3a derives a reasonable value from the specified basic name).
 
* '''-v''' - Displays the version info and copyright information
 
* '''-v''' - Displays the version info and copyright information
  
 
== Examples ==
 
== Examples ==
Incomplete. ''Talk about how icons should be made and where to get them''
+
Given ''example.bin'' as input, create ''example.g3a''. The default name is "James", and the French-localized name is  "Jacques". Icons are foo.png and bar.bmp, respectively.
Icons must be either .bmp or .png imagesThe icons should follow [http://www.cemetech.net/forum/viewtopic.php?t=6211 these guidelines] in order to conform to other addins.
+
  mkg3a -n James -n fr:Jacques -i uns:foo.png -i sel:bar.bmp example.bin

Revision as of 13:48, 25 August 2012

mkg3a is a utility to combine icons and a binary into a .g3a file executable on the Prizm. The project page for mkg3a is located here. If you installed mkg3a from source yourself, it should have installed a manpage, which provides all of the below information (run man mkg3a).

Download

You can find the latest "release" of mkg3a on Bitbucket, or Tari provides a build of (generally) the latest revision in hg [1].

Usage

Note that mkg3a has been changed since the release of PrizmSDK 3. If the commands listed don't work, please update your mkg3a

The command line usage of mkg3a is in the form of mkg3a [OPTION] input-file [output-file]. The input file should be a .bin file, as emitted by gcc/ld with the Prizm linker script. The output file is a .g3a file, the name of which is auto-generated from your input file name (chop off '.bin', tack on '.g3a') if not specified. mkg3a accepts the following options:

  • -i (uns|sel):file - This is used to specify the unselected and selected icons for when the addin is displayed in the Prizm's Main Menu. These images may be in .bmp or .png. In both cases, the images must be 24-bit RGB, and BMP files may not be compressed. They must also be the correct size (64 by 92 pixels). For icon design guidelines, refer to the Addin Usability Guidelines.
  • -n lc:name - This is used to set the localized name of the addin. This is needed because addins contain the name in different languages and for different modes. If you omit lc: (such as -n name), then mkg3a will default to the basic name. You can specify as many language names as you want, however the last one specified for a given language will be used. The list of language codes are listed below:
    • en - English name
    • es - Spanish name.
    • de - German name.
    • fr - French name.
    • pt - Portuguese name.
    • zh - Chinese name.
    • basic - (Default for mkg3a) Unlocalized name.
    • internal - This appears to be used by the Prizm internally. It should generally not be set manually (mkg3a derives a reasonable value from the specified basic name).
  • -v - Displays the version info and copyright information

Examples

Given example.bin as input, create example.g3a. The default name is "James", and the French-localized name is "Jacques". Icons are foo.png and bar.bmp, respectively.

mkg3a -n James -n fr:Jacques -i uns:foo.png -i sel:bar.bmp example.bin