20190825

• Updated engine to playtest-20190825
• Updated toolchain to work with the new OpenRA engine
• Linux and macOS applications no longer require a system Mono installation
• Added 64-bit Windows installer and portable packages (with -x86 and -x64 filename suffixes)
• Changed AppImage filename to include -x86_64 suffix.

This is a major update to the mod SDK. The following files have changed:

• .travis.yml
• Makefile
• make.ps1
• mod.config
• ExampleMod.sln
• packaging/linux/buildpackage.sh
• packaging/linux/include/AppRun.in
• packaging/linux/include/Eluant.dll.config (deleted)
• packaging/linux/include/OpenAL-CS.dll.config (deleted)
• packaging/linux/include/SDL2-CS.dll.config (deleted)
• packaging/linux/include/mod-utility.in
• packaging/osx/buildpackage.sh
• packaging/windows/buildpackage.nsi
• packaging/windows/buildpackage.sh

We recommend updating by making a backup of any custom icons you have set in the platform-specific packaging directories, deleting the packaging directory and all its contents, and then replacing it with the updated versions in this release before restoring your custom icons. Note that several files have been deleted, so extracting the new files over the top of the existing structure is not sufficient.

.travis.yml, Makefile, ExampleMod.sln, and make.ps1 should then be replaced with the updated versions in this release.

If your mod defines its own sln file you must update the Debug and Release configurations to build all projects as Any CPU and add a new Release-x86 configuration that builds all dll projects using the Release configuration, and all exe projects using the Release-x86 configuration. Refer to the ExampleMod.sln for more details.

The following changes made to mod.config:

• In the Core Configuration section:
  • Change ENGINE_VERSION to playtest-20190825
  • Add a new definition:

    # .dll filenames compiled by the mod solution for use by the runtime assembly check
    WHITELISTED_MOD_ASSEMBLIES="OpenRA.Mods.Example.dll"

    If your mod has deleted the Example dll then you should instead define this as

    # .dll filenames compiled by the mod solution for use by the runtime assembly check
    WHITELISTED_MOD_ASSEMBLIES=""

    or if you have your own mod dll(s) this should instead specify their name(s) separated by spaces.
• In the Packaging section:
  • Change PACKAGING_OSX_LAUNCHER_TAG to osx-launcher-20190506
  • Change PACKAGING_APPIMAGE_DEPENDENCIES_TAG to 20190506
• In the Advanced Configuration section:
  • Add new definitions:

    # List of .NET assemblies that we can guarantee exist
    # OpenRA.Game.dll is a harmless false positive that we can ignore
    WHITELISTED_OPENRA_ASSEMBLIES="OpenRA.Game.exe OpenRA.Utility.exe OpenRA.Platforms.Default.dll OpenRA.Mods.Common.dll OpenRA.Game.dll"
    
    # These are explicitly shipped alongside our core files by the packaging script
    WHITELISTED_THIRDPARTY_ASSEMBLIES="ICSharpCode.SharpZipLib.dll FuzzyLogicLibrary.dll MaxMind.Db.dll Eluant.dll rix0rrr.BeaconLib.dll Open.Nat.dll SDL2-CS.dll OpenAL-CS.dll"
    
    # These are shipped in our custom minimal mono runtime and also available in the full system-installed .NET/mono stack
    # This list *must* be kept in sync with the files packaged by the AppImageSupport and OpenRALauncherOSX repositories
    WHITELISTED_CORE_ASSEMBLIES="mscorlib.dll System.dll System.Configuration.dll System.Core.dll System.Numerics.dll System.Security.dll System.Xml.dll Mono.Security.dll"

If your mod includes any custom c# projects you must update their csproj files to use the new OpenRA standard template. Open each csproj file with a standard text editor and replace the file contents with the text in OpenRA.Mods.Example/OpenRA.Mods.Example.csproj. Find the <OutputPath> definition (line 9) and replace example with your mod ID.

This SDK version is not backwards compatible with previous OpenRA's engine versions, and you must proceed with the Engine update guide before your mod will run on the new release.

20190314

• Update engine reference for OpenRA release-20190314.

This is a minor update to target the latest engine version. Please see the notes for the 20190106 release for instructions on how to update from earlier engine versions.

20190106

• Added a --utility argument to the AppImage.
• Update engine reference for OpenRA playtest-20190106.

This is a minor update from the 20180923 release. The following files have changed:

• mod.config
• packaging/linux/buildpackage.sh
• packaging/linux/include/AppRun.in
• packaging/linux/include/mod-utility.in (new file)

When updating from the 20180923 SDK release we recommend overwriting the packaging/linux directory in your project with the new files.

This SDK version remains compatible with OpenRA's engine versions release-20180307 and newer. If you wish to update to the new playtest engine to take advantage of the new features then you may now proceed to the Engine update guide.

20180923

• Added a clearer error message when the packaging scripts are not executable
• Fixed the packaging scripts failing when a version tag contains a .
• Reverted macOS dark mode support (fixes black-screen rendering failure on later 10.14 betas)
• Fixed Travis CI integration (which was broken in 20180825)
• Removed unused .gitmodules file

This is a minor update from the 20180825 release. The following files have changed:

• .travis.yml
• Makefile
• mod.config
• packaging/windows/buildpackage.sh

When updating from the 20180825 SDK release we recommend individually replacing .travis.yml, Makefile and packaging/windows/buildpackage.sh in your project, and then changing the PACKAGING_OSX_LAUNCHER_TAG definition in mod.config to osx-launcher-20171118.

When updating from the 20180307 SDK release we recommend following the instructions from 20180729 using the updated 20180923 files, but omit the PACKAGING_OSX_LAUNCHER_TAG change (which was reverted in this release).

This SDK version remains compatible with OpenRA's engine versions release-20180307, playtest-20180729, and playtest-20180825. If your mod is targeting the playtest releases, however, we strongly recommend that updating to release-20180923 as soon as possible to take advantage of the latest bug fixes. If you wish to update to take advantage of these then you may now proceed to the Engine update guide.

20180825

• Fixed AppImage compatibility problems with Linux Mint
• Added clearer error messages when travis (or other Linux users) common errors in mods developed on Windows
• Fixed crashes when running the "portable" windows distributions
• Updated default engine version to playtest-20180825
• Removed leftover references to the removed ExternalPort setting
• Added support for using wget instead of curl on Linux

This is a relatively minor update to the mod SDK. The following files have changed:

• .travis.yml
• Makefile
• fetch-engine.sh
• launch-dedicated.cmd
• launch-dedicated.sh
• packaging/linux/buildpackage.sh
• packaging/linux/include/AppRun.in
• packaging/osx/buildpackage.sh
• packaging/package-all.sh
• packaging/windows/buildpackage.sh

We recommend updating by individually replacing these 10 files on top of your existing 20180729-based SDK template.

This SDK version remains compatible with OpenRA's engine versions release-20180307 and playtest-20180729. If your mod is targeting playtest-20180729, however, we strongly recommend that you update to playtest-20180830 as soon as possible to take advantage of the bug fixes in the revised playtest. If you wish to update to take advantage of these then you may now proceed to the Engine update guide.

20180729

• Added Linux AppImage packaging
• Added checks for missing mod.yaml definitions and outdated engine files
• Added ability to customize the license text shown in the Windows installer
• Added ability to decouple the mod.yaml (in-game) version and packaging version
• Fixed an issue when mods contain symbolic links (note: this is not recommended)
• Improved support for shipping default-mod files in mod packages
• Added support for macOS 10.14 dark titlebars
• Updated default engine version to playtest-20180729

This is a major update to the mod SDK. We recommend updating by making a backup of your mod.config and any custom icons you have set in the platform-specific packaging directories, and then overwriting all the SDK files in your project with the updated versions in this release. Replace the icons (and don't forget to add new icons for your Linux releases!) and mod.config file, and then make the following changes to your mod.config:

• In the Core Configuration section remove the INCLUDE_DEFAULT_MODS definition.
• In the Packaging section add the following definitions

  # Path to the file containing the text to show in the Windows installer license dialog
  PACKAGING_WINDOWS_LICENSE_FILE="./COPYING"
  
  # The git tag to use for the AppImage dependencies.
  PACKAGING_APPIMAGE_DEPENDENCIES_TAG="20180723"
  
  # Space delimited list of additional files/directories to copy from the engine directory
  # when packaging your mod. e.g. "./mods/modcontent" or "./mods/d2k/OpenRA.Mods.D2k.dll"
  PACKAGING_COPY_ENGINE_FILES=""
  
  # Overwrite the version in mod.yaml with the tag used for the SDK release
  # Accepts values "True" or "False".
  PACKAGING_OVERWRITE_MOD_VERSION="True"
  

  and change PACKAGING_OSX_LAUNCHER_TAG to osx-launcher-20180723.
• In the Advanced Configuration section add the following definitions

  # The url to download the OpenRA AppImage dependencies.
  PACKAGING_APPIMAGE_DEPENDENCIES_SOURCE="https://github.com/OpenRA/AppImageSupport/releases/download/${PACKAGING_APPIMAGE_DEPENDENCIES_TAG}/libs.tar.bz2"
  
  # Temporary file name used when downloading the OpenRA AppImage dependencies.
  PACKAGING_APPIMAGE_DEPENDENCIES_TEMP_ARCHIVE_NAME="libs.tar.bz2"
  

This SDK version remains compatible with OpenRA's engine version release-20180307. If you wish to update to take advantage of the improvements added in playtest-20180729 then you may now proceed to the Engine update guide.

20180307

• Update engine reference for OpenRA release-20180307.
• Fixed an issue preventing the engine from downloading on Windows.

20180218

• Update engine reference for OpenRA release-20180218.

20171014

• Update engine reference for OpenRA release-20171014.

20170923

• Added a check and error message for users attempting to run the SDK using PowerShell 2.0 or older.
• Added a "portable" windows package -winportable.zip.
• Renamed macOS installer package suffix to -macOS.zip to distinguish it from the portable windows package.

This is a minor update to the SDK files. You can upgrade by replacing the content of your packaging directory, make.ps1, and .travis.yml files with the newer versions included with this release, and then set ENGINE_VERSION="playtest-20170923" in your mod.config. If you would like to update the files manually then you can compare the changed files.