openage
=======

**openage**: a volunteer project to create a free engine clone of *Age of Empires II*,
primarily aimed at POSIX platforms such as **GNU/Linux**,
comparable in its goals to projects like [OpenMW](https://openmw.org/), [OpenRA](http://openra.net/) and [OpenTTD](http://openttd.org/).

openage uses the original game assets (such as sounds and graphics), but (for obvious reasons) doesn't ship them.
To play, you require *an original AoE II installation or [AoE II: HD](http://store.steampowered.com/app/221380/)* (wine is your friend; in the near future, setup discs will be supported).

[![build status](https://travis-ci.org/SFTtech/openage.svg?branch=master)](https://travis-ci.org/SFTtech/openage)
[![Bountysource](https://www.bountysource.com/badge/team?team_id=6026&style=bounties_received)](https://www.bountysource.com/teams/sfttech/issues?utm_source=SFTtech&utm_medium=shield&utm_campaign=bounties_received)
[![tip for next commit](http://prime4commit.com/projects/143.svg)](http://prime4commit.com/projects/143)
[![github stars](https://img.shields.io/github/stars/SFTtech/openage.svg)](https://github.com/SFTtech/openage/stargazers)
[![#sfttech on Freenode](http://img.shields.io/Freenode/%23sfttech.png)](https://webchat.freenode.net/?channels=sfttech)


The foundation of **openage**:

Technology     | Component
---------------|----------
**C++14**      | Engine core
**Python**     | Scripting, media conversion, in-game console, code generation
**Cython**     | Glue code
**CMake**      | Build system
**OpenGL2.1**  | Rendering, shaders
**SDL2**       | Cross-platform Audio/Input/Window handling
**Opus**       | Audio codec
**Humans**     | Mixing together all of the above

Our goals *include*:

* Fully authentic look and feel
  * This can only be approximated, since the behaviour of the original game is mostly undocumented,
    and guessing/experimenting can only get you this close
  * We will not implement useless artificial limitations (max 30 selectable units...)
* Multiplayer (obviously)
* Optionally, [Improvements](/doc/ideas/) over the original game
* AI
* Re-creating free game assets
* An easily-moddable content format
* A powerful integrated Python console and interface, comparable to [blender](http://blender.org/)

Our goals specifically *exclude*:

* Network compatibility with the original game.
  You really wanna have the same problems again?
* Binary compatibility with the original game.
  A one-way script to convert maps/savegames/missions to openage is planned though.


Current State of the Project
----------------------------

 - What features are currently implemented?

See [doc/status.md](/doc/status.md).

 - What can I do once I start the game?

See [docs/usage.md](/doc/usage.md).

 - What's the plan?

See [doc/milestones.md](/doc/milestones.md). We also have a [list of crazy xor good ideas](/doc/ideas).


Dependencies, Building and Running
----------------------------------

 - How do I get this to run on my box?

See [doc/building.md](/doc/building.md).

 - I compiled everything. Now how do I run it?

You first need to use [the convert script](/doc/media_convert.md) (will be automated in the near future!) to convert the original game assets to the (a lot saner and more moddable) openage format. Then, you can simply run the game using `./openage --data=assets`.

 - Waaaaaah! It
  - segfaults
  - prints error messages I don't want to read
  - ate my dog

All of those are features, not bugs.
To turn them off, use `./run --dont-segfault --no-errors --dont-eat-dog`.

If this still does not help, try the [contact section](#contact)
or the [bug tracker](https://github.com/SFTtech/openage/issues).

ATM, openage is mostly designed to be built and run inside the development folder via `make run`, `./run`, `./run.py` or `python3 -m openage` (those all are equivalent), but `make install` might actually work! Run the installed version from outside the development folder by typing `python3 -m openage`.

Development Process
-------------------

* What does openage development look like in practice?

[doc/development.md](/doc/development.md).

* Can I help?

[doc/contributing.md](/doc/contributing.md).


Project documentation is accompanying the source code in the `doc/` folder:

- Have a look at the [doc directory](/doc/).
- We use Doxygen, as described in the [doc readme](/doc/README.md)
- Unfortunately, docs that are kept in some seperate folder keep getting outdated... thus, as much of the doc as possible is kept directly in the source code.


Windows Version
---------------

None of us uses Windows, so a port has low priority.

However, we're using cross-platform libraries wherever possible, so a port should be pretty easy to accomplish. We'll eventually look into porting using `mingw`/`msys2`.

If you want to beat us to it, go for it!

We'd prefer as few preprocessor switches as possible, keep those centralized.

Contributing
============

* Being typical computer science students, we hate people.
* Please don't contact us.
* Nobody likes Age of Empires anyway.
* None of you is interested in making openage more awesome anyway.
* We don't want a community.
* Don't even think about trying to help.

Guidelines:

* No **bugreports** or **feature requests**, the game is perfect as is.
* Don't try to **fix any bugs**, see above.
* Don't implement any features, your code is crap.
* Don't even think about sending a **pull request**
* Don't note the irony, you idiot
* We even have a [list of tasks](/doc/tasks.md) that definitely don't need your work.

To prevent accidential violation of one of those guidelines, you should *never*

* [learn git](http://git-scm.com/book/en/Git-Basics)
* [fork the repo](https://help.github.com/articles/fork-a-repo)
* [learn python](http://docs.python.org/3/tutorial/appetite.html)
* [learn c++14](http://www.cplusplus.com/doc/tutorial/)
* read the code and documentation
* contribute anything to the code
* [contact us](#contact)

cheers, happy hecking.

Contact
-------

Most of us hang around on our **IRC** channel (`#sfttech` on `freenode.net`).
Do not hesitate to ping us, we might not see your message otherwise.

There's no openage mailing list, but the github issue tracker comes pretty close to it: Everybody who 'watches' the repository will receive all the issue tracker posts via mail, and can even reply directly via their mail client. All issue tracker discussions are auto-posted to the IRC channel by a bot. Use the issue tracker for any sorts of discussion, proposal or questions that the IRC is unsuitable for.

License
-------

**GNU GPLv3** or later; see [copying.md](copying.md) and [legal/GPLv3](/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.
