From 732c16724647c6f3e9bb5385d3e556e10a974a51 Mon Sep 17 00:00:00 2001 From: bartteunis Date: Mon, 26 Aug 2019 14:36:16 +0200 Subject: [PATCH] Update README.md Basic documentation --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 283342f..f6f0689 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# blender-rigidbody-exporter \ No newline at end of file +# Blender Rigidbody Exporter +This plugin exports the rigidbody world from a Blender project. +It exports to a json-based format that closely resembles the structure of the bpy API. + +## Collision shapes +### Mesh +The mesh is the most flexible collision shape and allows several face loops. + +### Convex Hull + + +### Cone, Cylinder, Capsule, Sphere +These all map to a circle shape in 2D. + +### Box +Corresponds to a rectangle/box shape in 2D. + +### More complex shapes +Some models have a very complex shape. +The requirement for a polygon shape is that it should be convex. +For a more complex concave shape this can be solved by using "Mesh > Clean up > Split Concave Faces"