From f02f526e20f05f461fa1e598ab26a998e2ee4898 Mon Sep 17 00:00:00 2001 From: cosmonaut Date: Sat, 23 Jan 2021 00:30:00 -0800 Subject: [PATCH] README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..cb34d292 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# MoonWorks + +MoonWorks is a free cross-platform game development framework. Its implementation is heavily inspired by [FNA](https://github.com/FNA-XNA/FNA), which is itself a free implementation of the Microsoft XNA API. + +MoonWorks wraps native-code implementations in managed C# for clean high-level abstractions that still run fast. It's simple and it tries to stay out of your way as much as possible. + +MoonWorks *does* provide the components you need to implement a functioning game: window management, input, graphics, 3D math utilities, and audio. + +MoonWorks *does not* include things like a built-in physics engine, a GUI editor, or a standard rendering pipeline. My philosophy is that these decisions and tools are better made per-team or per-project. + +If you don't mind learning what a vertex buffer is, this framework is for you. + +## Dependencies + +* [SDL2](https://github.com/flibitijibibo/SDL2-CS) - Window management, Input +* [Refresh](https://gitea.moonside.games/MoonsideGames/Refresh) - Graphics +* [FAudio](https://github.com/FNA-XNA/FAudio) - Audio + +## License + +MoonWorks is released under the zlib license. See LICENSE for details. + +MoonWorks uses code from the FNA project, released under the Microsoft Public License. See fna.LICENSE for details. By extension it uses code from the Mono.Xna project, released under the MIT license. See monoxna.LICENSE for details.