diff options
| author | Alexander Pickering <alex@cogarr.net> | 2018-06-28 21:05:17 -0600 |
|---|---|---|
| committer | Alexander Pickering <alex@cogarr.net> | 2018-06-28 21:05:17 -0600 |
| commit | 45e61c74802af739736d33c82f27596b45987eee (patch) | |
| tree | ff7b8629016972d07e62f6c0d9c66974884640f8 | |
| parent | edce7ebfda180433ddead8fcb70780954ef32aa9 (diff) | |
| download | brokengine-45e61c74802af739736d33c82f27596b45987eee.tar.gz brokengine-45e61c74802af739736d33c82f27596b45987eee.tar.bz2 brokengine-45e61c74802af739736d33c82f27596b45987eee.zip | |
Update readme with new build instructions
Updated the readme to use simplified (download and) build instructions.
| -rw-r--r-- | README.md | 29 |
1 files changed, 9 insertions, 20 deletions
@@ -8,20 +8,10 @@ Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.o 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 +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 @@ -30,10 +20,9 @@ Currently, documentation does not exist... I'll get around to it before 1.0 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 +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 |