blender-iks-to-fks - npm Package Compare versions

Comparing version 1.4.2 to 2.0.0

manual-installation-instructions.md

@@ -1,2 +0,2 @@
-[Download the Addon file](https://github.com/chinedufn/blender-iks-to-fks/releases/download/1.3.4/convert-ik-to-fk.py)
+[Download the Addon file](https://github.com/chinedufn/blender-iks-to-fks/releases/download/2.0.0/convert-ik-to-fk.py)
 
@@ -3,0 +3,0 @@ Go to your user preferences in Blender

package.json

 {
   "name": "blender-iks-to-fks",
-  "version": "1.4.2",
+  "version": "2.0.0",
   "description": "A Blender script that takes a mesh and armature that use IKs and other non-deformation bones and creates a new mesh and armature that uses only FK bones",
@@ -5,0 +5,0 @@ "main": "bin/ik2fk.js",

README.md

@@ -16,3 +16,3 @@ blender-iks-to-fks [![npm version](https://badge.fury.io/js/blender-iks-to-fks.svg)](http://badge.fury.io/js/blender-iks-to-fks) [![Build Status](https://travis-ci.org/chinedufn/blender-iks-to-fks.svg?branch=master)](https://travis-ci.org/chinedufn/blender-iks-to-fks)
 
-It does this by generating a new mesh and FK rig that copy the animations of your original mesh and rig.
+It does this by generating a new mesh and FK rig that copy the animations of your original mesh and rig, but without the IK / Constraints.
 
@@ -32,2 +32,6 @@ ---
 
+## Supported Blender Versions
+
+We currently support `Blender 2.80`.
+
 ## Install
@@ -74,2 +78,15 @@
 
+### Via bpy.ops
+
+You can run this addon in the Blender Python Console or via any python script by running
+
+```sh
+bpy.ops.rigging.iktofk()
+```
+
+If the currently active object (`bpy.context.active_object`) is an armature then `blender-iks-to-fks` will run on that
+armature. Otherwise it will run on the first armature that it finds in your Blender scene.
+
+You can convert multiple armatures by iterating over them, setting them at the active object and then calling `bpy.ops.rigging.iktofk()`
+
 ### ik2fk CLI
@@ -101,2 +118,8 @@
 
+## Running Tests
+
+```sh
+npm run test
+```
+
 ## Have an idea? Confused?
@@ -106,10 +129,8 @@
 
-## Was this helpful?
+## See Also
 
-Were you lost trying to find a way to convert your bones, but now you're found?
+- [Landon](https://github.com/chinedufn/landon) - tooling for exporting data from Blender such as meshes and armatures.
 
-[![Support](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/chinedufn)
-
 ## License
 
 (c) 2017 Chinedu Francis Nwafili. MIT License

test/test.js

@@ -105,3 +105,5 @@ var test = require('tape')
 
-        t.ok(rootSquareMeanError < 0.0002, 'New mesh and armature have the same animations as the old mesh and armature')
+          // In blender 2.79 this was <0.0002 .. In 2.80 we moved it up to <0.0036 ..
+          // After looking at a few more complicated models the before and after still seem to be nearly identical.
+        t.ok(rootSquareMeanError < 0.0036, `Root square mean error between old and new armature ${rootSquareMeanError}.`)
       })
@@ -128,2 +130,3 @@ }
       t.ok(
+        // Original mesh and armature, new mesh and armature, camera = 5 objects total
         stdout.indexOf('The number of objects is: 5') > -1, 'Mesh and armature were automatically detected'
@@ -130,0 +133,0 @@ )

No alert changes

Improved metrics

Total package byte prevSize

2566011

increased by0.09%

Number of package files

21

increased by31.25%

Lines of code

358

increased by0.28%

Number of lines in readme file

132

increased by18.92%

No dependency changes