README

A simple Qt-based 2D game engine.

========
1. Build
========

1.1) Dependencies

* Qt5
  	Qt5 source repository: https://qt.gitorious.org/qt/qt5

* Box2D >= 2.2.1
	http://box2d.org

1.2) Building

Available QMake parameters:

* QTPATH (Optional)
	Prefix where Qt has been installed. It is required to install
	Quasi's QML import plugin and related files.
	The default path is /usr/lib/qt5

* BOX2DPATH (Optional)
	Path to Box2D installation. If your Linux distro packaging system
	provides the required version, it is recommended to use it to install
	the library and devel files.

* BUILD_EXAMPLES (Optional)
	Use BUILD_EXAMPLES=1 to build usage examples.

Sample build from Quasi's root source tree:

$ mkdir build && cd build
$ qmake QTPATH=/opt/Qt5 BOX2DPATH=/usr BUILD_EXAMPLES=1 ..
$ make
$ sudo make install


===========
2. Examples
===========

If you have installed the QML plugin to the proper Qt import directory,
you can run the examples directly from their specific build directories.

Example:

$ cd $(QUASI_BUILD_TREE)/examples/box2dpolygon_circle/
$ ./box2dpolygon_circle

If Quasi QML plugin was not installed you need first to export QML_IMPORT_PATH
environment variable:

$ export QML_IMPORT_PATH=$(QUASI_BUILD_TREE)/src/imports