From 60fd391b88cdd52ec4a23edcc85be40b2348c785 Mon Sep 17 00:00:00 2001 From: Jozufozu Date: Wed, 16 Jun 2021 11:45:16 -0700 Subject: [PATCH] Create README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..e7016a414 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Flywheel +A modern engine for modded Minecraft. + + +The goal of this project is to provide tools for mod developers so they no longer have to worry about performance, or limitations of Minecraft's archaic rendering engine. +That said, this is primarily an outlet for me to have fun with graphics programming. + + +## Instancing + +So far, Flywheel provides an alternate, unified path for entity and tile entity rendering that takes advantage of GPU instancing. In doing so, Flywheel gives the developer the flexibility to define their own vertex and instance formats, and write custom shaders to ingest that data. + +### Shader Abstraction +To accomodate the developer and leave more in the hands of the engine, Flywheel provides a custom shader loading and templating system to hide the details of the CPU/GPU interface. This system is a work in progress. There will be breaking changes, and I make no guarantees of backwards compatibility.