readme

README.md

@@ -0,0 +1,25 @@
+# Sub-Tick Minecraft Diorama Renderer
+
+A lightweight, scriptable WebGL2 rendering engine designed to visualize and explain the sub-tick
+execution of Minecraft blocks (specifically Redstone components) through interactive, 3D dioramas.
+
+### Project Goals
+
+* **Educational Visualization:** Provide clear, interactive 3D visualizations of Minecraft mechanics
+  for technical documentation.
+* **Sub-Tick Accuracy:** Allow authors to script and step through intermediate, "invalid" block
+  states that occur between game ticks to explain complex redstone logic.
+* **Resource Pack Compatibility:** Directly ingest and parse standard Minecraft vanilla resource
+  pack files (`.json` models, blockstates, and `.png` textures).
+* **Lightweight & Embeddable:** Designed to be embedded natively into web-based technical articles
+  with minimal overhead. Multiple dioramas may be embedded in a document, and multiple dioramas may
+  represent the same block diagram from different viewpoints. The diagrams will stay synchronized.
+
+### Non-Goals (Scope Limits)
+
+* **Not a Clone:** We do not aim to support exact rendering parity. This is a techincal block
+  diagram viewer only.
+* **Not a simulator:** This is a scriptable rendering engine only, suitable for technical authors to
+  create schematics and explain sub-tick redstone timings. It does not simulate anything, so every
+  block event must be scripted explicitly. In the future, we may build a simulation layer on top of
+  this which streams block events to the renderer, but no concrete plans exist yet.