aboutsummaryrefslogtreecommitdiff
path: root/doc/topics/readme.md.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/topics/readme.md.html')
-rw-r--r--doc/topics/readme.md.html81
1 files changed, 81 insertions, 0 deletions
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 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>Reference</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Brok[en]gine</h1>
+
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Download">Download </a></li>
+<li><a href="#Documentation">Documentation </a></li>
+<li><a href="#Misc">Misc </a></li>
+</ul>
+
+
+<h2>Topics</h2>
+<ul class="">
+ <li><strong>readme</strong></li>
+</ul>
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../index.html">net</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+ # Brok[en]gine
+<p>![logo](https://cogarr.net/files/alex/brokenengine_small.png)
+<p>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.
+<p>## Download
+<p>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.
+<p>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
+<p>## Documentation
+Currently, documentation does not exist... I'll get around to it before 1.0
+<p>## Misc.
+This project is under very heavy development. Expect lots of code churn for the foreseeable future.
+<p>### 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
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2018-07-03 16:38:22 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>