Initial Vectorail GC format library

README.md

@@ -0,0 +1,30 @@
+# Vectorail GC
+
+Headless parsers and evaluators for Groove Coaster interoperability. The
+library has no windowing, rendering, audio, input, or gameplay dependencies.
+
+## Formats
+
+- arcade stage `.dat` streams and note opcodes;
+- stage catalog and pattern data;
+- `.tumo` model geometry;
+- MTX texture archives;
+- RVB scenes and layout snapshots;
+- effect and UV animation data.
+
+No game files are distributed with this repository. Applications must point
+the library at data obtained from their own installation or hardware dump.
+
+## Build
+
+```sh
+cmake -S . -B build
+cmake --build build
+cmake --install build --prefix /desired/prefix
+```
+
+Consumers use `Vectorail::GC` for the base parsers and
+`Vectorail::GCEffects` for the GLM-based effect evaluator.
+
+Vectorail GC is distributed under the MIT License.
+