From 3b6e505f0d5ac7133ac379a5be36e19479604a54 Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Tue, 3 Jul 2018 20:23:01 -0600 Subject: Started working on documentation Useing ldoc --- doc/topics/readme.md.html | 81 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 doc/topics/readme.md.html (limited to 'doc/topics') diff --git a/doc/topics/readme.md.html b/doc/topics/readme.md.html new file mode 100644 index 0000000..f250100 --- /dev/null +++ b/doc/topics/readme.md.html @@ -0,0 +1,81 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ + # 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 with submodules `git clone --recurse-submodules https://cogarr.net/source/cgi.cgit/brokengine` +2. Download make, g++, ect. Windows users can use [mingw](https://mingw.org). Open a terminal and cd into this folder, and run `make` +3. Binaries can be found in bin/(client|server)/bin/ +4. 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. Lua-defined textures +1. Lua-defined materials +2. Lua-defined models +3. Lua-defined hitboxes +4. Networking utilities +5. Make a tech demo game + + +

+
+
+generated by LDoc 1.4.6 +Last updated 2018-07-03 16:38:22 +
+
+ + -- cgit v1.2.3-70-g09d2