openage README

The project's README from github.com/SFTtech/openage. As one markdown file: README.md.

openage

openage: a volunteer project to create a free engine clone of the Genie Engine used by Age of Empires, Age of Empires II (HD) and Star Wars: Galactic Battlegrounds, comparable to projects like OpenMW, OpenRA, OpenSAGE, OpenTTD and OpenRCT2.

openage uses the original game assets (such as sounds and graphics), but (for obvious reasons) doesn't ship them. To play, you require any of the original games (AoE1, AoE2) or their Definitive Edition releases.

github stars #sfttech on matrix.org GPL licensed

Contact

Contact Where?
Issue Tracker GitHub SFTtech/openage
Development Blog blog.openage.dev
Subreddit reddit /r/openage
Discussions GitHub Discussions
Matrix Chat matrix #sfttech:matrix.org
Money Sink money sink

Technical foundation

Technology Component
C++20 Engine core
Python3 Scripting, media conversion, in-game console, code generation
Cython Python/C++ Glue code
Qt6 Graphical user interface
CMake Build system
OpenGL Rendering, shaders
Opus Audio codec
nyan Content Configuration and Modding
Humans Mixing together all of the above

Goals

But beware, for sanity reasons:

Current State of the Project

Important notice: At the moment, "gameplay" is basically non-functional. We're implementing the internal game simulation (how units even do anything) with simplicity and extensibility in mind, so we had to get rid of the temporary (but kind of working) previous version. With these changes, we can (finally) actually make use of our converted asset packs and our nyan API! We're working day and night to make gameplay return*. If you're interested, we wrote detailed explanations on our blog: Part 1, Part 2, Monthly Devlog.

* may not actually be every day and night

Operating System Build status
Debian Sid Kevin CI status
Ubuntu 24.04 LTS Ubuntu 24.04 build status
macOS macOS build status
Windows Server 2019 Windows Server 2019 build status
Windows Server 2022 Windows Server 2022 build status

Installation Packages

There are many missing parts for an actually working game. So if you "just wanna play", you'll be disappointed, unfortunately.

We strongly recommend building the program from source to get the latest, greatest, and shiniest project state :)

If you need help, maybe our troubleshooting guide helps you.

Quickstart

Alternative approach: You can build and run the project using Docker. See Running with docker for more details.

All of those are features, not bugs.

To turn them off, use ./bin/run --dont-segfault --no-errors --dont-eat-dog.

If this still does not help, try our troubleshooting guide, the contact section or the bug tracker.

Contributing

You might ask yourself now "Sounds cool, but how do I participate and get famous contribute useful features?".

Fortunately for you, there is a lot to do and we are very grateful for your help.

Where do I start?

Ok, I found something. What now?

How do I contribute my features/changes?

I want to help, but I'm not a programmer...

Then openage might be a good reason to become one! We have many issues and tasks for beginners. You just have to ask and we'll find something. Alternatively, lurking is also allowed.


Cheers, happy hecking!

Development Process

What does openage development look like in practice?

How can I help?

All documentation is also in this repo:

License

GNU GPLv3 or later; see copying.md and legal/GPLv3.

I know that probably nobody is ever gonna look at the copying.md file, but if you want to contribute code to openage, please take the time to skim through it and add yourself to the authors list.

openage (SFTtech/openage)

Searching Database…

14.5K ·GitHub
What is this?openage is a volunteer-built open-source clone of the Genie Engine used by Age of Empires, Age of Empires II (HD), and Star Wars: Galactic Battlegrounds, aiming to recreate the original gameplay with a modern, moddable engine.
Is this a full game or just an engine?It is an engine, not a standalone game: you still need your own copy of the original Age of Empires or AoE2 (or their Definitive Editions) to supply the assets, since openage does not ship them.
How do I build and run it?Clone the repository, install the platform-specific dependencies listed in doc/building.md, then build with CMake; afterwards run 'cd bin && ./run' to launch, or use the provided Docker setup instead of building locally.
What does the engine stack look like under the hood?The engine core is written in C++20 with Python3 handling scripting, media conversion and code generation, Cython providing the glue layer, Qt6 for the GUI, OpenGL for rendering, Opus for audio, and nyan for content and mod configuration.
Can I actually play a full match right now?No — the README states gameplay is currently basically non-functional while the internal simulation is being rebuilt, and there are no ready-to-use packages for Linux, Windows or macOS yet, so you must build from source.
Which operating systems does it support?openage targets Linux, Windows, and macOS, with CI builds tested on Debian Sid, Ubuntu 24.04 LTS, macOS, and Windows Server 2019/2022.
What is nyan?Nyan is openage's own content-configuration and modding notation, used to define game data in an easily moddable format instead of hardcoded values.
Does it interoperate with the original game's online services?No, by design there is no network or binary compatibility with the real Age of Empires — openage won't connect to its multiplayer servers or reuse its save/map formats directly.
Can AI opponents use machine learning?The engine exposes an integrated Python console and API for scripting unit and game behavior, and the project's stated goal is to let contributors apply machine learning for AI scripting.
What are similar projects?OpenRCT2, bgfx, luanti, Yakumo, SFML, tiled, entt, TrinityCore
Creator
SFTtech
Size
19 MB
Stars
14.5K
Age
12y
Commits · 90 Days