io_scene_b3d/README.md

# io_scene_b3d

Blender Import-Export script for Blitz 3D .b3d files

## Installation

* Userspace method: click File - User Preferences - Add-ons - Install Add-on from File.
The add-on zip file should contain io_scene_b3d directory. Don't forget to click Save User Settings afterwards.
* Alternative method: copy or symlink the io_scene_b3d directory to blender user directory, e.g. to
%APPDATA%\Blender Foundation\Blender\2.79\scripts\addons\io_scene_b3d.

## Debugging

* Userspace method: every time you make a change the script has to be reloaded using Reload Scripts command (F8).
* Alternative method: use my debug shortcut, Shift+Ctrl+D. It resets scene, reloads the script and imports a test file.

## TODO

### Import

* Mind that animation is not yet implemented. Working on it!
* Nodes use original quaternion rotation and it affects user interface.
Maybe it's worth to convert it into euler.

### Export

* Exported files sometimes contain animation keys that go outside the animation.
Assimp doesn't import them so I've added an extra frame, just to be safe.
It's better to recalculate the animation using existing keys.
UPDATE: could not reproduce, reverted. Will double check later.

## License

This is all GPL 2.0. Pull requests welcome.

The import script is a heavily rewriten script from Glogow Poland Mariusz Szkaradek.
I've had to rewrite all the chunk reader stuff and all the import stuff, because Blender API
has heavily changed since then.

The export script uses portions (copied almost verbatim, just ported to Blender Import-Export format)
from supertuxcart project by Diego 'GaNDaLDF' Parisi. Since it's all GPL-licensed, he shouldn't mind.

The b3d format documentation (b3dfile_specs.txt) doesn't have a clear license (I assume Public Domain)
but it was hard to find, so I just put it here in the repository as well.

## Alternatives

* [Assimp](http://assimp.sourceforge.net/) - doesn't read .b3d animation in most cases, maybe I have acquired a very particular set of files
* [fragMOTION](http://www.fragmosoft.com/) - works fine most of the time, but it's a terrible nagware and the only suitable export is .smd

## References

* https://github.com/joric/gnome