GettingStarted

If you just want to run a pre-built version of the code, see Installation.

Setting up a Development Environment

You will need a system that satisfies the MinimumSystemRequirements for running OpenRA.

Git Commands

Setting up:

git config --global user.name $YOU
git config --global user.email you@example.com

Fork the repo on Github, and then clone it locally, and set up your pushurl:

git clone git://github.com/$YOU/OpenRA.git
git config remote.origin.pushurl git@github.com:$YOU/OpenRA.git

Now add upstream so you can track it:

git remote add upstream -f git://github.com/OpenRA/OpenRA.git

Do the same for any other repos you want to track.

Now to sync up to upstream:

git fetch --all
git merge upstream/master

To work on something:

git checkout -b myfeature
... hack, add, commit ...

Before publishing your changes, it's a good idea to rebase them up to the latest upstream version: git fetch --all git rebase upstream/master

Now test that it still works, and then publish your changes:

git push myfeature