From 3dd1a0caee0f13bfa48103e245f4eded37575a4e Mon Sep 17 00:00:00 2001 From: LunarAkai Date: Tue, 29 Jul 2025 00:46:01 +0200 Subject: [PATCH] readme --- README.md | 43 ++++++++++--------------------- docs/modules/core.md | 0 docs/modules/graphics.md | 0 docs/modules/logger.md | 0 docs/modules/math.md | 0 docs/modules/winit.md | 0 docs/structs/core/Game.md | 0 docs/structs/core/GameTime.md | 0 docs/structs/window/GameWindow.md | 0 moonhare_engine/README.md | 1 + moonhare_event/README.md | 1 + moonhare_graphics/README.md | 1 + moonhare_log/README.md | 2 ++ moonhare_window/README.md | 1 + playground/README.md | 2 ++ 15 files changed, 21 insertions(+), 30 deletions(-) delete mode 100644 docs/modules/core.md delete mode 100644 docs/modules/graphics.md delete mode 100644 docs/modules/logger.md delete mode 100644 docs/modules/math.md delete mode 100644 docs/modules/winit.md delete mode 100644 docs/structs/core/Game.md delete mode 100644 docs/structs/core/GameTime.md delete mode 100644 docs/structs/window/GameWindow.md create mode 100644 moonhare_engine/README.md create mode 100644 moonhare_event/README.md create mode 100644 moonhare_graphics/README.md create mode 100644 moonhare_log/README.md create mode 100644 moonhare_window/README.md create mode 100644 playground/README.md diff --git a/README.md b/README.md index 7087ffc..946a819 100644 --- a/README.md +++ b/README.md @@ -4,39 +4,22 @@ Game Engine written in Rust (Currently this is just a fun side project, sooo if this engine works eventually, use it at your own risk :D) +## My Goals +- make a somewhat simple (mainly 3D) Game Engine +- provide some abstraction so that for example different graphics APIs _could_ be used + - focus is on OpenGL +- allow Scripting via C# +- learn a metric ton about rust, game engine architecture and graphics programming :3 + ## Architecture: -### Classes/Structs -#### Core -- [Core/Game](docs/structs/core/Game.md) -- [Core/GameTime](docs/structs/core/GameTime.md) +### Crates +- [MoonhareEngine](moonhare_engine/) +- [MoonhareEvent](moonhare_event/) +- [MoonhareGraphics](moonhare_graphics/) +- [MoonhareLog](moonhare_log/) +- [MoonhareWindow](moonhare_window/) -#### Debug -- - -#### ECS -- - -#### Graphics -- - -#### Logger -- - -#### Math -- - -#### Window -- [Window/GameWindow](docs/structs/window/GameWindow.md) - -### Modules -- core -- debug -- ecs -- graphics -- logger -- math -- Window ### Game Loop: - Start Run diff --git a/docs/modules/core.md b/docs/modules/core.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/modules/graphics.md b/docs/modules/graphics.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/modules/logger.md b/docs/modules/logger.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/modules/math.md b/docs/modules/math.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/modules/winit.md b/docs/modules/winit.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/structs/core/Game.md b/docs/structs/core/Game.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/structs/core/GameTime.md b/docs/structs/core/GameTime.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/structs/window/GameWindow.md b/docs/structs/window/GameWindow.md deleted file mode 100644 index e69de29..0000000 diff --git a/moonhare_engine/README.md b/moonhare_engine/README.md new file mode 100644 index 0000000..41f07f5 --- /dev/null +++ b/moonhare_engine/README.md @@ -0,0 +1 @@ +# MoonhareEngine \ No newline at end of file diff --git a/moonhare_event/README.md b/moonhare_event/README.md new file mode 100644 index 0000000..2e23d89 --- /dev/null +++ b/moonhare_event/README.md @@ -0,0 +1 @@ +# MoonhareEvent \ No newline at end of file diff --git a/moonhare_graphics/README.md b/moonhare_graphics/README.md new file mode 100644 index 0000000..99bc13c --- /dev/null +++ b/moonhare_graphics/README.md @@ -0,0 +1 @@ +# MoonhareGraphics \ No newline at end of file diff --git a/moonhare_log/README.md b/moonhare_log/README.md new file mode 100644 index 0000000..986809d --- /dev/null +++ b/moonhare_log/README.md @@ -0,0 +1,2 @@ +# MoonhareLog +This crate provides a Wrapper around the log and fern crates for logging in the Moonhare Game Engine. \ No newline at end of file diff --git a/moonhare_window/README.md b/moonhare_window/README.md new file mode 100644 index 0000000..5e66601 --- /dev/null +++ b/moonhare_window/README.md @@ -0,0 +1 @@ +# MoonhareWindow \ No newline at end of file diff --git a/playground/README.md b/playground/README.md new file mode 100644 index 0000000..cb1a84d --- /dev/null +++ b/playground/README.md @@ -0,0 +1,2 @@ +# Playground +Binary Application for testing engine functionality \ No newline at end of file