Upgrading mods to a new release - UberWaffe/OpenRA GitHub Wiki

This page is a work in progress. Feel free to help finish it!

release-20131223 to release-20140608

Upgrading a mod:

  1. Edit your mod.yaml to match the base cnc or ra mods. TODO: list the actual changes
  2. Run OpenRA.Utility.exe --upgrade-mod <your mod id> 20131223 to automatically apply the majority of the rule changes you will need. Any maps in the directories referenced by your mod.yaml will also be converted.
  3. Apply the manual changes described below to your mod and any included maps.

Upgrading a map:

  1. Run OpenRA.Utility.exe --upgrade-map <path/to/map> 20131223 to automatically apply the majority of the rule changes.
  2. Apply the manual changed described below.

Manual changes:

  • Altitude is no longer parsed from actor templates in maps. If you have modified the map actors to define a custom height, you must change the Altitude definition to a CenterPosition.
  • The construction yard crane animation logic has been moved into a new trait. Add a WithBuildingPlacedAnimation or WithBuildingPlacedOverlay trait to your construction yard to restore the animation. [#5124]
  • The "battle control initialized" notification logic has been moved into a new trait. Add a StartGameNotification trait to the world actor to restore the announcement. [#4999]
  • Add the Demolishable trait to any actors that should be C4-able.
  • Mods that use custom TileSize in mod.yaml must specify both width and height.
  • A DisabledOverlay trait has been split from RenderBuilding. Use it together with RequiresPower and CanPowerDown for actors that should be dimmed when disabled.
  • A new cursor definition is required for "attackoutsiderange".
  • Mods can now include a 96x96 logo.png for the mod selector.
  • Mods can now include a 296x196 preview.png for the mod selector.