From 6c077751982ea2c7bd2d9262b01b9f8602f80dc8 Mon Sep 17 00:00:00 2001 From: onelin Date: Fri, 31 Oct 2025 23:40:16 +0100 Subject: Update README for master --- README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e094da7..ece8027 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,6 @@ Daw === -This branch contains the work of moving the engine to OpenGL, using GLFW & GLAD. - -Everything is getting rewritten. - ---- - Daw is yet another hobby WIP game engine. It is written in C99 and can be compiled and linked to easily in any CMake @@ -56,9 +50,9 @@ These are the dependencies that you likely need to install yourself. Other dependencies are pulled automatically. -### Building fr +### Compiling -Generate the build files using +Generate the build files by running ``` cmake -S . -B build ``` @@ -72,8 +66,9 @@ This should, in theory, build the engine as a shared library and run without any warnings nor errors. The way the engine is designed, it is very useless as a shared library, and does -nothing if it is not configured as a subproject of the "game" itself. -See [tools/cmake/DawAddState.cmake](tools/cmake/DawAddState.cmake) for more information. +nothing if it is not configured as a subproject of the "game" itself. See +[tools/cmake/DawAddState.cmake](tools/cmake/DawAddState.cmake) for more +information. ## Planned features @@ -84,19 +79,13 @@ planned to implement. * GLFW & OpenGL * Better cross platform support (ie. windows) -## Remaining work before mergin this branch +## TODO This section exists to provide an overview of the tasks that needs to be done -before merging the glfw branch back into master. -* [x] Batch rendering - + Adding models now requires a transform. - + We require `renderbatch_refresh` to finalize the renderobj buffer. - + Still require `RenderObject_new` in the end, to make the buffers. - + [ ] We also want enable the user to automatically generate IBO, by exposing - some API call. - + [ ] Should make a "`renderbatch_update_renderobject`" API, that uploads - all the changed vertex data, possibly by using a `.dirty` flag. - + [ ] Merge textures from RenderObjects into texture atlas -* [ ] (auto?) Index buffers +* [ ] Enable the user to automatically generate IBO, by exposing some API call. +* [ ] Should make a "`renderbatch_update_renderobject`" API function, that + uploads all the changed vertex data, possibly by using a `.dirty` flag. +* [ ] Merge textures from RenderObjects into texture atlas +* [ ] automatically generate Index buffers + [ ] Missing IBO generation, should be easy, ``` vertices[n][3]f32 |> sort ( @@ -112,6 +101,7 @@ before merging the glfw branch back into master. - [ ] These should be resized with the window + [ ] Should be passed as parameter. _we want to completely get rid of `GLOBAL_PLATFORM`_ +* [ ] Get rid of CMake? [0]: https://github.com/0undefined/rogue/blob/a947b0092d91920d56eb9af6a39bd1bd05e145fc/CMakeLists.txt -- cgit v1.3