godot-4-importality

Importality

Importality - is an add-on for Godot engine for importing graphics and animations from popular formats.

📜 Table of contents

• Introduction
• Features
• How to install
• How to use
• How to help the project

📝 Introduction

I previously published an add-on for importing Aseprite files. After that, I started developing a similar add-on for importing Krita files. During the development process, these projects turned out to have a lot in common, and I decided to combine them into one. Importality contains scripts for exporting data from source files to a common internal format, and scripts for importing data from an internal format into Godot resources. After that, I decide to add new export scripts for other graphic applications.

🎯 Features

• Adding recognition of source graphic files as images to Godot with all the standard features for importing them (for animated files, only the first frame will be imported).
• Support for Aseprite (and LibreSprite), Krita, Pencil2D, Piskel and Pixelorama files. Other formats may be supported in the future.
• Import files as:
  • Atlas of sprites (sprite sheet) - texture with metadata;
  • SpriteFrames resource to create your own AnimatedSprite2D and AnimatedSprite3D based on it;
  • PackedScene’s with ready-to-use Node’s:
    • AnimatedSprite2D and AnimatedSprite3D
    • Sprite2D, Sprite3D and TextureRect animated with AnimationPlayer
• Several artifacts avoiding methods on the edges of sprites.
• Grid-based and packaged layout options for sprite sheets.
• Several node animation strategies with AnimationPlayer.
• Importing any other graphics formats as regular images with external command line utilities.

🥁 Upcoming updates by voting Reddit users

1. Layers names filters (for layers visibility overriding)
2. Linux and MacOS scripts to run Krita as different user (to resolve import hanging while Krita instance is running)
3. Something else (what?) - users are undecided
4. New target resource-types
5. More flexible definition of borders around sprites
6. Ability to specify normal-map layer name

💽 How to install

1. Install it from Godot Asset Library or:
   • Clone this repository or download its contents as an archive.
   • Place the contents of the addons folder of the repository into the addons folder of your project.
2. Adjust the settings in Editor Settings -> Importality
   • Specify a directory for temporary files.
   • Specify the command and its parameters to launch your editor in data export mode, if necessary. How to configure settings for your graphical application, see the corresponding article on the wiki.

👷 How to use

Be sure to read the wiki article about the editor you are using! These articles describe the important nuances of configuring the integration!

• Aseprite/LibreSprite (Important)
• Krita (Critical!)
• Pencil2D (Important)
• Piskel (No integration with the application. The plugin uses its own source file parser)
• Pixelorama (No integration with the application. The plugin uses its own source file parser)
• Other graphics formats (Important)

Then:

1. Save the files of your favorite graphics editor to the Godot project folder.
2. Select them in the Godot file system tree. They are already imported as a Texture2D resource.
3. Select the import method you want in the “Import” panel.
4. Customize its settings.
5. If necessary, save your settings as a default preset for this import method.
6. Click the “Reimport” button (you may need to restart the engine).
7. In the future, if you change the source files, Godot will automatically repeat the import.

💪 How to help the project

If you know how another graphics format works, or how to use the CLI of another application, graphics and animation from which can be imported in this way - please offer your help in any way. It could be:

• An issue describing the bug, problem, or improvement for the add-on. (Please attach screenshots and other data to help reproduce your issue.)
• Textual description of the format or CLI operation.
• Pull request with new exporter.
• A temporary or permanent license for paid software to be able to study it and create an exporter. For example for:
  • Adobe Photoshop
  • Adobe Animate
  • Adobe Character Animator
  • Affinity Photo
  • Moho Debut / Moho Pro
  • Toon Boom Harmony
  • PyxelEdit
  • and others