# Introduction

Quad Ruled War (qrw) is a turn based strategy game taking place on a board seperated into squares much like chess. The goal was to produce a minimalistic game for short and fast battles. It only supports hot seat modus for two players on one machine.

## Building

![travis build status badge](https://travis-ci.org/namelessvoid/qrwar.svg?branch=master)

The source comes with an CMake file and dependes on:

- CMake
- SFML (>= 2.5)
- TinyXML (>= 2.0)
- yaml-cpp 
- CppUnit (for tests)
- gtest & gmock (for tests)

For detailed instructions you can have a look at the Dockerfiles locatet at `ci/`. Note, however, that they also pull in optional dependencies only required for executing tests within a docker container.

If you've got any problems building the game feel free to create an issue.

Note: Installation is not yet supported.

## Game

### Skirmish

The game has a single game mode "skirmish" in which to players compete in a hot-seat match against each other. At first, units are deployed in the marked areas known as deployment zones. Afterwards, the the turn-based battle begins and both move and attack until all units of one player have been eliminated.

### Mapeditor

The map editor is used to create new maps for the skirmish game mode. Terrain, structures and deployment zones can be placed and erased by the tools on the right. To grant access to walls, stairs have to be placed on adjacent tiles. To rotate stairs, right click them.


## Third party resources

- [Knightsquest.ttf](http://moorstation.org/typoasis/designers/graham/fonts/knightsq.zip)

  True Type Font by [GemFonts](http://moorstation.org/typoasis/designers/gemnew/home.html). See the .zip file for further information.

Move from re-structured text to markdown and delete all outdated info
Move from re-structured text to markdown and delete all outdated info
