From ed6b961b61ae5d2e66e78243b1bdccb3677bf64b Mon Sep 17 00:00:00 2001 From: Doyle Thai Date: Sat, 24 Sep 2016 15:11:34 +1000 Subject: [PATCH] Update readme to include features of engine --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 08eed33..b503955 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ # Dengine Dengine is a 2d game engine developed with OpenGL and low-level libraries in C. The main goal of Dengine is to facilitate learning from many aspects of Computer Science. Alongside Dengine a game is being built which guides the development of features for the game. Dengine is inspired by Handmade Hero, with a focus on developing as many features with minimal libraries, such that it is not too time-consuming and counter-productive to do so. +## Milestones +Milestones/features/capabilities that have been added to the engine. + +### "Handmade" API +- Custom Standard Library: (improved as is required) (e.g. strlen, atoi, itoa) +- Custom Math Library: (improved as is required) +- Custom String Library +- Custom Memory Allocator: alloc memory from preallocated blocks +- Custom XML Parser: for reading game data config + +### Rendering +- Animation playback: from spritesheets +- Batched rendering: minimise draw calls grouped on texture & color modulation +- Generate on runtime bitmap font sheet from font file +- Rendering sprites: through GLEW and GLFW to OpenGL programmable pipeline +- Rendering rects and text + +### Other +- Audio API: through OpenAL and STB Vorbis for audio functionality +- Audio streaming +- Asset loading system using hashtables +- Collision using AABB +- Debug services/display +- Input parsing, delayed, raw read +- IMGUI style GUI: Buttons, textfields, scroll bars +- Moveable windows +- Primitive entity system +- Primitive battle system + ## Building Dengine is currently being developed using Visual Studio 2015. You can build the project by executing the (preferred) **build.bat** in the src folder, or simply opening the project in Visual Studio and compiling.