OpenRA / OpenRAModSDK

Software Development Kit for building your own games using the OpenRA engine.
http://www.openra.net
GNU General Public License v3.0
121 stars 68 forks source link

Add compatibility for upstream toolchain changes #156

Open pchote opened 4 years ago

pchote commented 4 years ago

We will need to update the SDK to account for the following upstream PRs when the time comes to branch a new playtest series.

List to be edited as work is completed upstream.

pchote commented 3 years ago

Draft release notes:

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

We recommend updating by making a backup of your packaging/artwork directory, deleting the packaging directory, and then replacing it with the updated directory structure in this release before restoring your custom artwork. Note that many files have been deleted, so extracting the new files over the top of the existing structure is not sufficient.

.travis.yml should be deleted and replaced with the new .github directory structure.

.gitignore, Makefile, make.ps1, fetch-engine.sh, launch-dedicated.cmd, launch-dedicated.sh, launch-game.cmd, launch-dedicated.sh, utility.cmd, utility.sh should then be replaced with the updated versions in this release.

The following changes are required in your mod.config:

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.

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.