Go to file
2017-10-14 12:34:38 +01:00
mods/example Update engine to f75115a. 2017-06-29 19:00:57 +01:00
OpenRA.Mods.Example Fix the Copy SourceFiles afterbuild event 2017-05-29 13:58:41 +01:00
packaging Add portable .zip build for windows 2017-09-23 20:14:28 +01:00
.gitignore Add .DS_Store to .gitignore. 2017-07-13 20:53:06 +01:00
.gitmodules Implement new automatic engine management. 2017-06-29 19:00:57 +01:00
.travis.yml Add portable .zip build for windows 2017-09-23 20:14:28 +01:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT and CONTRIBUTING documentation. 2017-08-22 20:45:30 +01:00
CONTRIBUTING.md Note the PowerShell >=3 requirement in CONTRIBUTING.md. 2017-09-23 20:36:53 +01:00
COPYING Add GPLv3 COPYING file 2017-07-23 12:06:54 +01:00
ExampleMod.sln Reference engine by projects to support "Jump to Definition". 2017-04-28 19:12:15 +01:00
fetch-engine.sh Parse user.config in fetch-engine.sh. 2017-08-22 19:14:06 +01:00
launch-dedicated.cmd Add user.config support for local overrides. 2017-06-30 16:15:47 +01:00
launch-dedicated.sh Do not error out of scripts that do not require 'make' if 'make' is not present 2017-08-26 19:45:05 +01:00
launch-game.cmd Fix the crash dialog always being shown on windows 2017-07-19 21:10:18 +01:00
launch-game.sh Do not error out of scripts that do not require 'make' if 'make' is not present 2017-08-26 19:45:05 +01:00
make.cmd Try to bypass the security warning 2017-05-27 12:01:29 +02:00
make.ps1 Note the PowerShell >=3 requirement in CONTRIBUTING.md. 2017-09-23 20:36:53 +01:00
Makefile Do not print success message when building or cleaning mod source 2017-08-26 13:17:15 +01:00
mod.config Update engine version to release-20171014. 2017-10-14 12:34:38 +01:00
README.md Add link to FAQ wiki page. 2017-08-22 20:47:52 +01:00
utility.cmd Add user.config support for local overrides. 2017-06-30 16:15:47 +01:00
utility.sh Fix MOD_SEARCH_PATHS when INCLUDE_DEFAULT_MODS is true. 2017-07-09 12:12:36 +01:00

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, and provide entrypoints to run development versions of your project and to generate platform-specific installers for your players.

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.