Update notes: release 20180307 to release 20180923

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

Release 20180307 to Playtest 20180729

ColorValidator pre-set color choices

The ColorValidator definition in mod.yaml now accepts a TeamColorPresets definition. The color picker preset list will be empty if this is not defined [see #14853].

Additional mod metadata options

Mods should define additional fields in their mod.yaml Metadata section [see #15185]:

• Website defines a URL to their mod's website.
• WebIcon32 defines a URL to a 32x32px mod icon (this should match icon.png in your mod directory).

These fields will be used in the online game listings to provide more visibility for your mod.

Mods can now optionally define their own credits file that will be displayed in a tab in the in-game Credits menu [see #15204].

Add a ModCredits block your mod.yaml like so:

ModCredits:
	ModTabTitle: My Short Title
	ModCreditsFile: mymod|AUTHORS

MiniYaml comment changes

The MiniYaml parser now parses comments instead of discarding them. This means that they must now obey the standard rules for indentation. You must manually search for comments and make sure that the comment character is indented at the appropriate level. For example: INCORRECT:

Packages:
# Load packages from the support directory
	~^Content/mymod

CORRECT:

Packages:
	# Load packages from the support directory
	~^Content/mymod

INCORRECT:

 pips:
 	groups:
 		Start: 8
 		Length: 10
 		Offset: 9, 5
 	medic:
 		Start: 20
#	ready:
#		Start: 3
#	hold:
#		Start: 4
 	tag-fake:
 		Start: 18
 		Offset: 0, 2

CORRECT:

 pips:
 	groups:
 		Start: 8
 		Length: 10
 		Offset: 9, 5
 	medic:
 		Start: 20
	#ready:
	#	Start: 3
	#hold:
	#	Start: 4
 	tag-fake:
 		Start: 18
 		Offset: 0, 2

These changes must be made before attempting to run the semi-automated rule updater.

Shp(TD) automatic MouseBounds changes.

The Shp(TD) format loader now trims empty space from frames. This changes the automatic bounds that are calculated by the Interactable or Selectable traits for your units mouse area and selection rectangle. If your mod uses Shp(TD) for actor artwork then you may wish to define custom Bounds on the Selectable or Interactable traits to restore the previous selection rectangles [see #15198 for examples].

EditorPlayer actor.

The map editor now requires an EditorPlayer actor that has the traits AlwaysVisible and Shroud. You must add manually define this actor in your player.yaml (or a different rule file of your choice).

Chrome changes for player authentication

Forum accounts are now integrated as player accounts (#15333). This comes with a set of changes to the UI (chrome yamls). It is best you view what changes were made to the default mods directly (the file names are links to the changes to the cnc mod) to understand what you have to add, remove or replace.

• chrome.yaml needs four new entries, admin-registered, admin-anonymous, player-registered and player-anonymous with respective glyphs added to the uibits (chrome.png).

• ingame-infostats.yaml:

  • Image@PROFILE and ClientTooltipRegion@PROFILE_TOOLTIP are required as children of the existing Container@PLAYER_TEMPLATE.
  • ClientTooltipRegion@CLIENT_REGION was removed.

• In lobby-players.yaml Container@TEMPLATE_EDITABLE_PLAYER, Container@TEMPLATE_NONEDITABLE_PLAYER, Container@TEMPLATE_EDITABLE_SPECTATOR and Container@TEMPLATE_NONEDITABLE_SPECTATOR received the same set of changes:

  • Image@ADMIN_INDICATOR was removed.
  • CLIENT_REGION was replaced by LATENCY_REGION, with CLIENT_TOOLTIP being replaced by LATENCY_TOOLTIP.
  • Image@PROFILE and ClientTooltipRegion@PROFILE_TOOLTIP were added to both the children of the container and to the children of each DropDownButton@PLAYER_ACTION.

• mainmenu.yaml received a new Container@PLAYER_PROFILE_CONTAINER entry.

• tooltips.yaml:

  • CLIENT_TOOLTIP was renamed to LATENCY_TOOLTIP and uses the LatencyTooltipLogic now.
  • INGAME_CLIENT_TOOLTIP changed to ANONYMOUS_PLAYER_TOOLTIP and uses the AnonymousProfileTooltipLogic.
  • A new Container@REGISTERED_PLAYER_TOOLTIP was added.

• A new playerprofile.yaml was added.

Chrome changes for player authentication

Some further changes were made to the player profile UI:

• chrome.yaml needs two new entries, authentication and authentication-disabled with respective glyphs added to the uibits (chrome.png).

• In lobby-servers.yaml and multiplayer-browser.yaml Image@REQUIRES_AUTHENTICATION should be added next to Image@PASSWORD_PROTECTED.

Playtest 20180729 to Playtest 20180825 / Release 20180923 / Release 20181215

Chrome changes for player authentication

Some further changes were made to the player profile UI:

• chrome.yaml needs two new entries, authentication and authentication-disabled with respective glyphs added to the uibits (chrome.png).

• In lobby-servers.yaml and multiplayer-browser.yaml Image@REQUIRES_AUTHENTICATION should be added next to Image@PASSWORD_PROTECTED.