# OpenAOE has been renamed to [Chariot](https://github.com/ChariotEngine/Chariot) and has a new maintainer. This repository will not see any more contributions.

# OpenAOE [![Build Status](https://travis-ci.org/angered-ghandi/OpenAOE.svg?branch=master)](https://travis-ci.org/angered-ghandi/OpenAOE)

The OpenAOE project is an attempt to re-implement the original Age of Empires (1997)
in an open-source manner so that:

 - The game may be ported to any desired platform.
 - Useful features from the sequel, such as build queuing, can be added to bring the original game closer to modern day RTS standards.
 - Enhancements, such as larger screen resolution support, can be made.

The OpenAOE project will strive to be as close to the original as possible.

For obvious reasons, you'll need an original Age of Empires CD to be able to
play it. No game data files will be committed to the repository.

**Note:** This is a work in progress. As of 2017-05-09, there is no game to be played. Just a demonstration of the original game assets being loaded and other proof of concepts. It will be a while before it is playable.

# WIP Screenshot

![Work in Progress Screenshot](https://cloud.githubusercontent.com/assets/20009343/16906794/daccd474-4c71-11e6-90ec-6821e5797b5c.png)

# Building and Running

## Overview

OS-specific instructions will follow. This section just gives a high level idea of what is required to build OpenAOE. You'll need the following:

1. [A Rust Compiler](https://www.rust-lang.org)
2. GCC (via [MINGW](http://www.mingw.org/) if on Windows), or [Microsoft Visual C++](https://www.visualstudio.com/en-us/visual-studio-homepage-vs.aspx)
3. [LibSDL2](https://www.libsdl.org/)

Rust's Cargo program should download and compile all of the other necessary dependencies.

## Building on Linux

1. Install Rust. Documentation for [manual install here](https://doc.rust-lang.org/book/getting-started.html).
2. Install SDL2. If you're on Ubuntu, you can use this command: `sudo apt-get install libsdl2-dev`.
3. Install GCC. For Ubuntu / Debian use the 'build-essential' package. For Arch linux use 'base-devel'
3. Build the game with: `cargo build --release`

## Building on Windows

1. Install [MinGW/MSYS2](http://msys2.github.io/)
2. Install SDL2: `pacman -S mingw-w64-x86_64-SDL2`
 1. Export the library folder: `echo "export LIBRARY_PATH=/usr/local/lib/:/lib/" >> /etc/profile"`
3. Install Rust:
 1. `curl https://sh.rustup.rs -sSf | sh`
 2. Use the GNU ABI (`i686-pc-windows-gnu` or `x86_64-windows-pc-gnu`)
3. Build the game with: `cargo build --release`

## Building on macOS

1. Install [Homebrew](http://brew.sh/).
2. Install Rust. `curl https://sh.rustup.rs -sSf | sh && rustup install toolchain nightly-x86_64-apple-darwin`
3. Install SDL2. `brew install sdl2`
4. Build the game with: `cargo build --release`

## Setting up the Game Data

Before you can run the game, you'll need to place the game's data in a place where the program can find it. On the game CD, there is a `game` directory with a language.dll, empires.exe, and a bunch of directories such as avi, campaign, and data. Either symlink that directory into the root of the project, or copy it over (it should keep the name "game"). Once the data is placed, you can run the game with:

```
$ cargo run --release
```

Alternatively, you can specify the location of the game data via command-line:

```
$ cargo run --release -- -d /media/AOE/game
```

Note that in these early versions, you may need to specify additional command line arguments, such as a path to a scenario file to load up. These may change over time, but the game should tell you what arguments are required and what to provide.

# Contributing

OpenAOE has been renamed to [Chariot](https://github.com/ChariotEngine/Chariot) and has a new maintainer. Please contribute to Chariot instead.