Upgrading mods to a new release

abcdefg30 edited this page Jun 19, 2016 · 6 revisions
Clone this wiki locally

release-20151224 to release-20160508

Note: The last parameter (20151224 in this case) is the old version you want to upgrade from. It can be any date in between, but not earlier than 20151224.

Upgrading a mod:

  1. Edit your mod.yaml to match the base cnc or ra mods. See below for a list of those changes.
  2. Run OpenRA.Utility.exe <your mod id> --upgrade-mod 20151224 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 <mod id for map> --upgrade-map <path/to/map> 20151224 to automatically apply the majority of the rule changes.
  2. Apply the manual changed described below.

Manual changes:

  • TransformOnPassenger was removed. Use the upgrades system to apply modifiers to the transport actor instead.
  • The 'SoundToVictim' property of the 'InfiltrateForCash' trait has been replaced with a 'Notification' property.
  • Mobile actors are now immobilized by Carryable, Cargo, DeployToUpgrade, and/or others using upgrade(s). This might require manual adjustments to work in your mod/map.

mod.yaml changes

  • 'RequiresMods' was introduced.
  • A new package system was introduced: You now reference mods with an "ID" rather than the path. For example, you list "$ra: ra" under 'Packages:' and replace all occurences of "./mods/ra/" with "ra|".
  • 'SoundFormats' was introduced. You should be fine by just defining "SoundFormats: Aud, Wav", however.
  • The 'LobbyDefaults' section was removed and the parameters were moved on to their associated traits.

release-20140722 to release-20141029

Note: The last parameter (20140722 in this case) is the old version you want to upgrade from. It can be any date in between, but not earlier than 20131226.

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 <your mod id> --upgrade-mod 20140722 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 <mod id for map> --upgrade-map <path/to/map> 20140722 to automatically apply the majority of the rule changes.
  2. Apply the manual changed described below.

Manual changes:

  • Owner: none is no longer supported for making actors unbuildable. Use Prerequisites: ~disabled instead.
  • The RequiresTech tag for hospital healing is no longer supported, and must be changed to using RequiresUpgrade. Refer to the ra and cnc mods to see how this is now done.