Godot SCML Importer

Godot is an awesome engine. Anyone using it deserves to be able to use the excellent resource and tools that exist along-side it. One of these is Spriter from BrashMonkey. I had access to a number of animated characters that I wanted to use with Godot and I didn't want to need to recreate the animations that I already had. This caused me to write this addon and share it so as to hopefully empower other godot users with the ability to use it.

Usage

• install plugin
• enable plugin
• import scml along with images maintaining the relativity that the SCML expects
• open the scml file in godot using the FileSystem dock
• adjust import settings using the godot import tab (first animation from file chosen as rest pose unless specified)

Tested/supported

• Godot
  • 3.1.1 (< 0.8.0)
  • 4.0, 4.1, 4.2 (0.9.1, 0.10.0)
  • 4.3 - 4.6 (1.0.0, 0.9.2, 0.10.0, 0.10.1, 0.10.2)
• Spriter SCML generator versions
  • r11

[!TIP] When upgrading to 0.9.2 you might need to manually adjust/reset your import settings on any scml files you already have in your project. The changes to the default preset won't be automatically applied for already imported scml files. The differences if you would want to apply these manually are:

• playback speed needs to be set to 1 instead of 3 in order to have the animation speed match the animation speed that was originally expected.
• loop wrap interpolation has been enabled by default since in the tested cases it meant the animations matched the spriter preview

Known limitations

Not currently supported

• absolute values as found in e.g. generator version b5.95 that the GreyGuy sample comes with
• eventline (not sure what use case these serve - haven't investigated)
• object types other than bone and the regular object (sprites)
• all interpolation is currently assumed to be linear - other interpolations aren't supported for values
• character map support not extensively tested (sample with expected outcome explanation will be appreciated)

Known implementation quirks

• Bone scale animations will not work as expected due to how the scale handling is implemented in the plugin. Currently not expected to change as not expecting it to be a common concern for users (at least not reported).