# Brok[en]gine

![logo](https://cogarr.net/files/alex/brokenengine_small.png)

Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.org/wordpress), [Irrlicht](irrlicht.sourceforge.net), [Lua](www.lua.org), and [various](nanomsg.org) [other](www.boost.org) technologies togeather to give a realtime, 3d, physics engine.

## Download

Binaries will not be provided until Brok[en]gine reaches version 1.0, if you want to try it out before then, you will have to build the engine yourself. 

1. Use [git](git-scm.com) to download this repo
2. Download the gnu autotools. (Make, g++, ect.)
3. Under the /lib folder, create folders:
  * bullet
  * irrlicht
  * luajit
  * nanomsg
4. Download and compile each of the libraries, statically if possible.
5. Remove version from the filename, and place the library in the folder.
   Ex. So that /bullet/libBulletCollision.a is a valid file
6. Back in the main directory, run `make`.
   If you need to, open the make file and adjust the directories
7. Binaries can be found in /bin/(client|server)/bin/
8. Initally ran scripts can be found at /bin/(client|server)/data/init.lua

## Documentation
Currently, documentation does not exist... I'll get around to it before 1.0

## Misc.
This project is under very heavy development. Expect lots of code churn for the foreseeable future.

### Roadmap

0. Refactoring
1. Get networked physics working
2. Refactoring
3. Allow lua-defined models, physics boxes, and textures
4. Refactoring
5. Make a tech demo game