diff options
| author | Alexander Pickering <alexandermpickering@gmail.com> | 2017-10-29 15:54:50 -0400 |
|---|---|---|
| committer | Alexander Pickering <alexandermpickering@gmail.com> | 2017-10-29 15:54:50 -0400 |
| commit | cc12503339004bae2f945e7f7339fc845b2a194f (patch) | |
| tree | 50f751c80d045c55ba7e1da5f37104c7628a4ec5 /README.md | |
| parent | 61c0c9f53d3a57ee7fd5db5faa74c4b51e2da396 (diff) | |
| download | brokengine-cc12503339004bae2f945e7f7339fc845b2a194f.tar.gz brokengine-cc12503339004bae2f945e7f7339fc845b2a194f.tar.bz2 brokengine-cc12503339004bae2f945e7f7339fc845b2a194f.zip | |
Added readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf96384 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Brok[en]gine + + + +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 |