Source Development Kit for building your own games using the OpenRA engine.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
OpenRA.Mods.Example Remove the CodeAnalysisRuleSet property from OpenRA.Mods.Example.csproj Aug 25, 2018
mods/example Update engine version to playtest-20180729. Jul 29, 2018
packaging Change spaces to tabs in packaging/windows/buildpackage.sh Sep 7, 2018
.gitignore Add .DS_Store to .gitignore. Jul 13, 2017
.travis.yml Fix travis not parsing .travis.yml Sep 2, 2018
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT and CONTRIBUTING documentation. Aug 22, 2017
CONTRIBUTING.md Note the PowerShell >=3 requirement in CONTRIBUTING.md. Sep 23, 2017
COPYING Add GPLv3 COPYING file Jul 23, 2017
ExampleMod.sln Reference engine by projects to support "Jump to Definition". Apr 28, 2017
Makefile Fix the indentation in the make file Sep 7, 2018
README.md Add a README paragraph about data licensing. Jul 1, 2018
fetch-engine.sh Add wget support to Linux fetch and build scripts. Aug 25, 2018
launch-dedicated.cmd Remove all uses of ExternalPort Aug 4, 2018
launch-dedicated.sh Remove all uses of ExternalPort Aug 4, 2018
launch-game.cmd Ensure required variables are defined before running scripts. May 2, 2018
launch-game.sh Ensure required variables are defined before running scripts. May 2, 2018
make.cmd Try to bypass the security warning May 27, 2017
make.ps1 Ensure required variables are defined before running scripts. May 2, 2018
mod.config Update engine version to playtest-20180825. Aug 25, 2018
utility.cmd Ensure required variables are defined before running scripts. May 2, 2018
utility.sh Ensure required variables are defined before running scripts. May 2, 2018

README.md

This repository contains a bare development environment for creating a new mod/game on the OpenRA engine.

These scripts and support files wrap and automatically manage a copy of the OpenRA game engine and common files during development, and generates Windows installers, macOS .app bundles, and Linux AppImages for distribution.

The key scripts in this SDK are:

Windows Linux / macOS Purpose
make.cmd Makefile Compiles your project and fetches dependencies (including the OpenRA engine).
launch-game.cmd launch-game.sh Launches your project from the SDK directory.
launch-server.cmd launch-server.sh Launches a dedicated server for your project from the SDK directory.
utility.cmd utility.sh Launches the OpenRA Utility for your project.
<not available> packaging/package-all.sh Generates release installers for your project.

To launch your project from the development environment you must first compile the project by running make.cmd (Windows), or opening a terminal in the SDK directory and running make (Linux / macOS). You can then run launch-game.cmd (Windows) or launch-game.sh (Linux / macOS) to run your game.

The example mod included in this repository provides the bare minimum structure to launch to the in-game main menu for the sole purpose of demonstrating the SDK. See Getting Started on the Wiki for instructions on how to adapt this template for your own projects. For common questions, please see the FAQ. See Updating to a new SDK or Engine version for a guide on updating your mod a newer OpenRA release.

The OpenRA engine and SDK scripts are made available under the GPLv3 license, and any executable code developed by a mod and loaded by the engine (i.e. custom mod DLLs, lua scripts) must be released under a compatible license. Your mod data files (artwork, sound files, yaml, etc) are not part of your mod's source code, so your are free to distribute these assets under different terms (e.g. allowing redistribution in unmodified form, but not for use in other works).