Utility

How to use OpenRA Utility

Linux users are normally familiar with the command line ("terminal" application), so they should simply add mono or mono --debug (additional information if something goes wrong) in front of all the following commands. Another note for Linux is that the files are normally found in /usr/share/openra. cd to there instead.

Windows users should run cmd.exe. Simply double-clicking OpenRA.Utility.exe will not work as it is not a GUI-capable application.

Navigate to your OpenRA directory: cd Program Files cd OpenRA Execute OpenRA.Utility.exe to see a help windows with it's syntax: OpenRA.Utility.exe

Usage: OpenRA.Utility.exe [OPTION] [ARGS]

  --settings-value KEY    (Get value of KEY from settings.yaml)
  --shp PNGFILE [PNGFILE ...]    (Combine a list of PNG images into a SHP)
  --png SPRITEFILE PALETTE [--noshadow] [--nopadding]    (Convert a shp/tmp/R8 to a series of PNGs, optionally removing shadow)
  --extract MOD FILES    (Extract files from mod packages to the current directory)
  --remap SRCMOD:PAL DESTMOD:PAL SRCSHP DESTSHP    (Remap SHPs to another palette)
  --transpose SRCSHP DESTSHP START N M [START N M ...]    (Transpose the N*M block of frames starting at START.)
  --docs MOD    (Generate trait documentation in MarkDown format.)
  --lua-docs MOD    (Generate Lua API documentation in MarkDown format.)
  --map-hash MAPFILE    (Generate hash of specified oramap file.)
  --map-preview MAPFILE    (Render PNG minimap of specified oramap file.)
  --map-upgrade-v5 MAPFILE MOD    (Upgrade a version 5 map to version 6.)
  --upgrade-map MAP CURRENTENGINE    (Upgrade map rules to the latest engine version.)
  --upgrade-mod MOD CURRENTENGINE    (Upgrade mod rules to the latest engine version.)
  --map-import MOD FILENAME    (Convert a legacy INI/MPR map to the OpenRA format.)

How to convert an icon with OpenRA Utility

The procedure not very complicated, though there are quirks due to the nature of the SHP format.

1. Get the palette of the game, e.g. Red Alert: OpenRA.Utility --extract ra temperat.pal
2. Extract the SHP file you want to edit or use as a template from the .MIX archives: OpenRA.Utility --extract ra ttnkicon.shp with ttnkicon.shp beeing the cameo for the tesla tank.
3. Get a PNG file with the right palette settings by extracting it using the right palette setting: OpenRA.Utility --png ttnkicon.shp temperat.pal
4. Use Photoshop, Paint.NET, GIMP (or any other program that uses the palette formats) to open the newly created ttnkicon.png and save the color table of the picture or edit the PNG file right here. If you want to start from scratch be sure convert your PNG format to 8bit/channel, using the custom palette saved before otherwise the in-game result will be pixel garbage.
5. OpenRA.Utility --shp YourImage0000.png