readme
This commit is contained in:
parent
a97e41f395
commit
3dd1a0caee
15 changed files with 21 additions and 30 deletions
43
README.md
43
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)
|
(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:
|
## Architecture:
|
||||||
|
|
||||||
### Classes/Structs
|
### Crates
|
||||||
#### Core
|
- [MoonhareEngine](moonhare_engine/)
|
||||||
- [Core/Game](docs/structs/core/Game.md)
|
- [MoonhareEvent](moonhare_event/)
|
||||||
- [Core/GameTime](docs/structs/core/GameTime.md)
|
- [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:
|
### Game Loop:
|
||||||
- Start Run
|
- Start Run
|
||||||
|
|
|
||||||
1
moonhare_engine/README.md
Normal file
1
moonhare_engine/README.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MoonhareEngine
|
||||||
1
moonhare_event/README.md
Normal file
1
moonhare_event/README.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MoonhareEvent
|
||||||
1
moonhare_graphics/README.md
Normal file
1
moonhare_graphics/README.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MoonhareGraphics
|
||||||
2
moonhare_log/README.md
Normal file
2
moonhare_log/README.md
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
# MoonhareLog
|
||||||
|
This crate provides a Wrapper around the log and fern crates for logging in the Moonhare Game Engine.
|
||||||
1
moonhare_window/README.md
Normal file
1
moonhare_window/README.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MoonhareWindow
|
||||||
2
playground/README.md
Normal file
2
playground/README.md
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
# Playground
|
||||||
|
Binary Application for testing engine functionality
|
||||||
Loading…
Add table
Add a link
Reference in a new issue