diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..38cedf7 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,23 @@ +## Requirements +*_NOTE:_ Right now the build proces of some third party libraries have not been converted and may need special tooling* + +#### Software +* Premake +* Git +* C++ Compiler + +## Windows development workflow +User premake to generate project files for the approperiate build method. +On Windows I assume you'll build with visual studio + +```bash +User:~$ premake vs2022 +``` + +## Linux development workflow +Use premake to generate project files for the approperiate build method. +On Linux I assume you'll build with something like make. + +```bash +User@Machine:~$ premake gmake2 +``` diff --git a/Features.md b/Features.md deleted file mode 100644 index 3cb58ca..0000000 --- a/Features.md +++ /dev/null @@ -1,26 +0,0 @@ -# Yoggie Engine features -## Features -**NOTE** __Not in any particular order__ -- Rendering - - OpenGL - - Vulkan - -- Logging - - Different for debug and release - - Different per OS - -- Physics - - PhysX - - Alternative for non-nvidia stuff?! - -- Basic Entity Component system - -- Graphical scripting ?? - -- Scripting support ( idk what language) - - LUA - -- Configuration options - - JSON - - LUA - - YAML diff --git a/README.md b/README.md index affaeff..7c0e060 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,34 @@ # Yoggie Engine - + +## Goal +Must support building a full game in 48 hours. +The goal is to build a mature enough engine to be capable of using during game jams. -## Screenshots +## Features +*_NOTE:_ Just because it is listed as a feature here does not imply it has been nor guarantees it ever will be implemented* +- Rendering + - OpenGL + - Vulkan + - Metal (Possibly) +- Logging + - Different for debug and release +- Physics + - PhysX + - Jolt Physics +- Entity Component system +- Graphical scripting (Possibly) +- Scripting support + - LUA + - C# (for object orientated approaches to gamedev) +- Configuration options + - JSON + - YAML + - INI - \ - \ - \ - \ - -## Planning -see [TODO](docs/TODO.md) \ -see [Features](Features.md) -_NOTE:_ - -The planning is moving away from markdown in favor -of gitea Projects. New planning will be visible on [this page](https://git.barink.dev/Nigel/MyGameEngine/projects). -## Requirements -#### Software -* Premake -* Git -* C++ Compiler - -## Windows development workflow -User premake to generate project files for the approperiate build method. -On Windows I assume you'll build with visual studio - -```bash -User:~$ premake vs2022 -``` - -## Linux development workflow -Use premake to generate project files for the approperiate build method. -On Linux I assume you'll build with something like make. - -```bash -User@Machine:~$ premake gmake2 -``` \ No newline at end of file +## More docs +[Todo list](TODO.md) \ +[Planning](https://git.barink.dev/Nigel/MyGameEngine/projects)\ +[Development](DEVELOPMENT.md)\ +[Show case](SHOWCASE.md) diff --git a/SHOWCASE.md b/SHOWCASE.md new file mode 100644 index 0000000..e136e13 --- /dev/null +++ b/SHOWCASE.md @@ -0,0 +1,17 @@ +## The engine development in pictures + +__Testing OpenGl with ImGui as a concept__ + + + +__Working on docking with different windows using ImGui__ + + + +__A first more complete look of the engine__ + + + +__Mixing deferred and forward rendering and adding a skybox__ + + \ No newline at end of file diff --git a/Screenshots/ImprovedRendering.png b/Screenshots/ImprovedRendering.png new file mode 100644 index 0000000..08b9cc9 --- /dev/null +++ b/Screenshots/ImprovedRendering.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55f563c17fff915cecdf3a316f0eb624ef63e23e5b4f35b19782dc692736f78c +size 894507 diff --git a/Screenshots/screen1.png b/Screenshots/OpenGLAndImGuiTest.png similarity index 100% rename from Screenshots/screen1.png rename to Screenshots/OpenGLAndImGuiTest.png diff --git a/Screenshots/YoggieEditor.png b/Screenshots/YoggieEditor.png deleted file mode 100644 index e57027a..0000000 --- a/Screenshots/YoggieEditor.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:55bd919a808a9cbaf24e379a75e7d9b928575bb8362ff83d23034058107d5a28 -size 66342 diff --git a/Screenshots/screen2.png b/Screenshots/screen2.png deleted file mode 100644 index 62b7d5f..0000000 --- a/Screenshots/screen2.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:daa76d1f8bb71e45c54e73145f4f313c31d55c60a7cc3e53653722f3a5dc239a -size 369689 diff --git a/TODO.md b/TODO.md index 892bac6..e8f6cfb 100644 --- a/TODO.md +++ b/TODO.md @@ -1,24 +1,23 @@ # Project Planning -**NOTE:** __Fairly detailed planning__ - - - Setup build system \ - Link with GLFW \ - Basic Window \ - Basic Triangle rendering \ - Basic IMGui \ - Basic Textures \ - Link GLEW or GLAD \ - Work on basic logging \ - Input handling \ - More shader work \ - Load FBX model files \ - Basic Physics \ - Running LUA \ - Lua Scripting \ - To far in the future - + Setup build system\ +Link with GLFW\ +Link GLEW or GLAD\ +Basic Window\ +Work on basic logging\ +Running LUA\ +Basic triangle rendering\ +Load model files\ +Basic ImGui \ +Skybox support\ +Basic Textures (Soon)\ +More shader work (Hopefully coming in January) \ +Input handling (Soon)\ +Basic Physics (Almost implemented)\ +Lua Scripting (Soon) \ +Basic Sound system +### What's next? +I am not sure what's going to be added next ## Resources https://renderdoc.org/ \