Skip to content

Latest commit

 

History

History
186 lines (126 loc) · 7.83 KB

README.md

File metadata and controls

186 lines (126 loc) · 7.83 KB
Raw

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, OpenRA, 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 an original AoE II : TC installation or AoE II: HD (Wine is your friend; in the near future, setup discs will be supported).

Bountysource tip for next commit github stars #sfttech on Freenode

reddit /r/openage forum

The foundation of openage:

Technology Component
C++14 Engine core
Python3 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)
  • Matchmaking and ranking with a haskell masterserver
  • Optionally, improvements over the original game
  • AI scripting in Python, you can use machine learning
  • Re-creating free game assets
  • An easily-moddable content format: nyan yet another notation
  • A powerful integrated Python console and interface, comparable to blender
  • Awesome infrastructure such as our own Kevin CI service

But beware, for sanity reasons:

  • No network compatibility with the original game. You really wanna have the same problems again?
  • No 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

Dependencies, Building and Running

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

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

    • Execute ./run, you will be prompted by the convert script to convert the original game assets to the (a lot saner and more moddable) openage format. The game starts when this is done..

  • 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 or the bug tracker.

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!

To run the globally installed version: python3 -m openage.

Development Process

What does openage development look like in practice?

Can I help?

All documentation is also in this repo:

  • Code documentation is embedded in the sources for Doxygen (see doc readme).
  • Have a look at the doc directory. This folder tends to outdate when code changes.

OS X Version

Building openage on OS X worked in the past, and might or might not work right now. Setting up continuous integration for this platform has some complications. Running a hackintosh VM seems to be not so legal, while buying dedicated hardware for it seems to be not so cheap. If you know of a legal and cost-free way of doing so or want to sponsor a semi-recent Mac Mini, please open a ticket in our issue tracker. Until then, PRs untested on OS X will make their way into the master branch und occasional breakage will occur.

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 mingw64/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.
  • Please ignore the easy tasks that could just be done.
  • Absolutely never ever participate in this boring community.
  • Don't note the irony, you idiot.

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

cheers, happy hecking.

Contact

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

For all technical discussion (ideas, problems, ...), use the issue tracker! It's like a mailing list.

For all interactive chit-chat, use our /r/openage subreddit!

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.