1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97d91e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Blenxy
+
+Epic Blender 2.79b template for Super Mario Galaxy modeling (honest work).
+
+https://humming-owl.github.io/smg-stuff/pages/tutorials/t8.html
+
+# TODO
+
+- Keep going with the interpolation stuff for CSV (BCK) animations.
+- CSV (BCK) importer and exporter still need some work to be done
+- ...
+
+# Features
+
+- Custom DAE Exporter for BMD/BDL conversion with SuperBMD.
+- Custom DAE Importer for DAEs that come from SuperBMD (only from SuperBMD).
+- CSV Exporter for the BCK animation type (to use with the J3D Animation Editor program). The animation must be applied to the bones of an Armature Object in Pose Mode. You then link the meshes to the bones through Vertex Groups.
+- CSV Importer for the BCK animation type.
+- Reference axis `SMG axis` shows on all 3d models to guide the visualization of a mesh in the Super Mario Galaxy reference system.
+- Custom mesurement unit `Galaxy Unit` (or GU) that is used to facilitate DAE import/export without the need to re-scale manually all the time (1 GU is 100 meters).
+- Epic Mario model as the default cube in Blender when starting the template (truly the most important part of the template >:]).
+- ...
+
+# Installation
+
+- Go to releases
+- Locate the last release
+- Download the `blenxy.zip` file
+- Open Blender and go to File > Application Templates > Install Template from File...
+- Search and select the `blenxy.zip` file
+- Enjoy the extension!
+
+# Contribute
+
+If you want to contribute or report an issue open a new issue in **Issues**. I will answer when I have time.
+
+# Thanks to
+
+- Tarsa for the J3D Animation Editor program.
+- Gabbo for pointing me out the Blender Python API reference.
+- RenolY2 for J3DView and SuperBMD.
+- The authors of the material I could read about BMD/BDL.
+- The many stackoverflow threads (or similar) in which Blender Python API issues are discussed.