Skip to content

Update notes: release 20190314 to release 20191117

abcdefg30 edited this page Jan 23, 2020 · 3 revisions

The following compatibility changes have been made between release-20180314 and release-20191117. Some of these changes will require manual actions on your part before you can run the semi-automated mod updater.

Release 20190314 to Release 20191117

UI Changes

If your mod inherits its UI, chrome.yaml, and hotkeys from one of the default mods then you just need to make the following changes:

  • Add gamesave-browser.yaml, gamesave-loading.yaml and ingame-debuginfo.yaml to the ChromeLayout section of mod.yaml.
  • If your mod is based on TD, remove ingame-observerstats.yaml from the ChromeLayout section of mod.yaml.
  • Define Ascender values for each font defined in the Fonts section of mod.yaml
  • Define GameSaved and GameLoaded notifications in your audio notifications.yaml.

Refer to the default OpenRA mod (RA/TD/D2k/TS) files for more details.

If your mod defines or overrides the default UI, you must refer to the folllowing PRs and apply the appropriate changes to your UI files:

  • Re-defined the way vertical alignment works for text labels. [#16592]
  • Added support for loading and saving missions/skirmish games. [#16411]
  • Added new spectator UI. [#16406, #16562, #16702]
  • Added new Hotkey mapping UI to the settings menu. [#16552, #16816]
  • Completely overhauled TD side and command bar UI. [#16359, #16644]
  • Adjusted Command Bar tooltips to account for removal of the "Alternate Transport" modifier key. [#16607]
  • Adjusted Command Bar tooltips to account for new "Force Land" helicopter command. [#16509]
  • Defined a new mouse attachment point to support the new directional support power feature. [#16479]
  • Added settings option to support new target line options. [#16893]
  • Removed obsolete settings option for strict activity checking. [#16481]
  • Added new tooltips for several UI components. [#16590]
  • Added coordinate display to map editor UI. [#16442]
  • Added new colour definitions for system UI messages. [#16355]

In case your mod defines a custom metrics.yaml file, you need to add an adaption of the colors for messages to it. (See https://github.com/OpenRA/OpenRA/pull/16355/files#diff-8e81f07cdc5a9d8a5024dd61ccd0972f)

Manual rules adjustments

  • Add GameSaveViewportManager to the Player actor to support game save/load. [#16411]
  • Add TimeLimitManager to the World actor to enable the "Time Limit" lobby option and Lua APIs for scripted maps. [#16317]
  • Define DisplayOrder on *ProductionQueue definitions to specify display order in the new spectator UI. [#16589]
  • Add the ActorPreviewPlaceBuildingPreview trait to your default ^Building definition to restore the building placement preview artwork. [#16553]
  • Add the Selection trait to the World actor to support the new selection logic. #16547: Add the Selection: trait to your world actor.
  • If you want trees and other actors to appear in your maps you should add the AppearsOnMapPreview trait then run the --refresh-map utility command on each of your maps. [#15731]

Runtime adjustments

  • If your mod includes custom C# logic you must remove any references to the System.Drawing namespace. Replacement types for Color, Rectangle and Size are provided in the OpenRA.Primitives namespace.