Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesHome
Welcome to the ☭ OpenRA project.
OpenRA is an open-source reimplementation of Westwood's Command & Conquer: Red Alert game engine, updated to use the hardware acceleration of modern video cards using OpenGL and cross-platform positional sound built upon OpenAL. It runs on Windows, Linux and macOS. Feel free to improve upon OpenRA. The development process is public and open to everyone. We are happy to include your patches after a code review.
- FAQ - Frequently Asked Questions
- Installation
- Hotkeys
- Settings
- Changelog
Community Resources
- Serverbrowser - List of current OpenRA games
- Master Server Stats - Player activity graphs
- OpenRA - Resources - Exchange units, maps and replays
- OpenRA Charts - Unit costs and tech tree
- IRC: #openra on freenode
- Mumble Server:
- Can be found in public server list under Europe -> Germany -> [64H] Multiplayer
- Also under direct address: 64h.mine.nu or mumble.openra.net (Port: 64738)
- Official Community Discord server
- Forums - Bulletin Board
- Game Replays
- Tournament/League Replays
- OpenRA - Red Alert Wiki
- PC Gaming Wiki
- Strategy Wiki
- Tutorials at Project Perfect Mod
Status
- OpenHub Code Metrics
- Travis CI Build Status
- AppVeyor CI Build Status
- Pingdom Uptime and Latency Measurement
- Issue Stats
Guides
- Playing the game - Learn the basics of gameplay
- Making maps guide - Learn how to make maps with easy and advanced settings
- Modding Guide - Learn how to make additional mods for the game, beyond RA and C&C
- Dedicated - Instructions on how to run a Dedicated OpenRA server
- Audio guide - How to edit, convert to aud and implement it on maps, units, and mods
- Pixelart - 3D models to sprite tutorials and other fileformat conversions
Development Topics
- Development Goals - A description of our philosophy and long term goals
- Contributing - Detailed guide on how to contribute to the project
- Compiling - How to setup your development environment
- Hacking - Understand the organisation of the source code
- Branches and Releases - Source code organisation and schedules
- License - Legal blurb about Free/Libre Open Source Software
-
Mod manifest - Structure and meaning of
mod.yamlentries - Sequences Introduction and Initialization - How to define sprite animation sequences
- Palettes and Remaps - How player colors are applied to sprites
- World Coordinate System - Differences between map and world coordinates
-
Traits - Documentation of the available YAML rules
- Traits (playtest) - Documentation of the upcoming new YAML rules
- Map scripting - How to write mission scripts in Lua
- Veterancy - How the unit promotion system works
- Coding Standard - please follow those when contributing patches
- Playtest or Release Checklist -- how to fire up the build server and quality assurance
- AI Development Guidelines - Guidelines for developing AI in OpenRA.
- Hacky AI - Thoughts on OpenRA's AI and where to go next with it.
- Reverse Engineering - Documentation on Westwood game files
- Translation - Localisation
- Glossary - Abbreviations and developer slang explained
