Skip to content

roccosportal/openage

 
 

Repository files navigation

openage

a free (as in freedom) implementation of

microsoft(r) age of empires II (tm) - the age of conquerors

brought to you by [SFT]Technologies.

this project is released under the GNU GPLv3 or later. see the COPYING file for that.

although we use the original game data files, our bundle does not ship any of the proprietary data used in aoc. in order to play, you have to provide a aoe2:aoc installation, or create free media files yourself.

dependencies

python3
python3 imaging library (PIL) -> pillow
opengl >=2.1
glew
ftgl
dejavu font
freetype2
fontconfig
cmake
sdl2
sdl2_image
gcc >=4.8 or clang >=3.3

how to compile && run

on POSIX:

./configure --mode=release
make
make media AGE2DIR="~/.wine-age/drive_c/programs/ms-games/aoe2"
cd data && ../bin/openage

for other make targets, see:

make help

on WINDOWS:

if you are keen on porting the game, go for it.

how to convert gamedata

The original aoc game data format is, lets say, a challenge to use. Therefore it has to be converted in order to be usable with openage.

The python script for that is in the convert/ folder, it will convert all the media files to formats being usable by openage.

This also means that you have to own the original media files, as we are way too lazy to create free media files for now, that's something the community can do..

To convert ALL original media files to openage format, execute the following:

python3 convert -o . $PATH_TO_YOUR_AOC_INSTALLATION

for example, if you installed aoc with wine:

python3 convert -o . ~/.wine-age/drive_c/programs/ms-games/aoe2

You will then find the converted files in ./data/age/

try

python3 convert --help

to see the usage, as you probably don't want to convert all the files (we don't use them yet..)

for converting only media files we do use at the moment, execute this:

python3 convert -o . $aoe2-installpath $(make medialist)

documentation

static docs

general documentation files reside in the doc/ directory. you can find ideas, milestones, planning and workflow descriptions etc in there.

dynamic docs

dynamic documentation files are generated from comments in the source code, using doxygen. the dynamic docs tend to only describe stuff you could also understand by reading the code itself, so don't expect too much, use the static docs instead.

after you configured the project, you can invoke

make doc

to create doxygen html and LaTeX files.

after creation, view them in a browser by

$(browser) bin/doc/html/index.html

or, if you want to create LaTeX documents:

make -C bin/doc/latex/ pdf
$(pdfviewer) bin/doc/latex/refman.pdf

i'd recommend looking at the source, as we try do write stuff as readable as possible.

contributing

  • we hate people, so don't even think about helping
  • i'm sure that nobody out there likes age of empires
  • none of you is interested in making this project more awesome
  • as always, this free software project has NO interest in creating a community
  • so please don't even think about helping us

guidelines:

  • don't write bugreports, openage is totally bugfree, of course
  • don't fix bugs yourself, see above, we don't have bugs
  • don't implement new features, they are crap anyway
  • don't EVER send pull-requests!
  • don't note the irony, you idiot

contact

currently you can use these communication channels to reach us morons:

cheers, happy hecking.

About

Free (as in freedom) clone of the Age of Empires II engine.

Resources

License

Stars

Watchers

Forks

Packages

No packages published