https://github.com/ninetailsrabbit/character-generator-importer-tool

This is an unofficial tool that can be used as a plugin in Godot to speed up the process of creating animations for the character generator 2.0
https://github.com/ninetailsrabbit/character-generator-importer-tool

character-generator godot importer pixel-art plugin rpg tool

Last synced: 17 days ago
JSON representation

This is an unofficial tool that can be used as a plugin in Godot to speed up the process of creating animations for the character generator 2.0

• Host: GitHub
• URL: https://github.com/ninetailsrabbit/character-generator-importer-tool
• Owner: ninetailsrabbit
• License: mit
• Created: 2024-10-10T16:41:19.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-03-04T12:34:03.000Z (about 2 months ago)
• Last Synced: 2025-04-12T20:06:03.863Z (17 days ago)
• Topics: character-generator, godot, importer, pixel-art, plugin, rpg, tool
• Language: GDScript
• Homepage: https://legendaryswordsman2.itch.io/character-generator
• Size: 539 KB
• Stars: 53
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


	


Character generator importer tool


  


   Speed up the process of creating animations from the character generator 2.0

	


	·

	Report Bug

	·

	Request Features

  









- [📦 Installation](#-installation)

- [Features](#features)

- [Getting started](#getting-started)

  - [Add the node to the scene](#add-the-node-to-the-scene)

  - [Choose the spritesheets to import](#choose-the-spritesheets-to-import)

  - [Select the parameters to import the spritesheets](#select-the-parameters-to-import-the-spritesheets)

  - [Select the adult animations you want to include](#select-the-adult-animations-you-want-to-include)

  - [Select the kid animations you want to include](#select-the-kid-animations-you-want-to-include)

  - [Click the "Generate Animations" button](#click-the-generate-animations-button)

- [How to import spritesheet parts](#how-to-import-spritesheet-parts)

# 📦 Installation

1. [Download Latest Release](https://github.com/ninetailsrabbit/character-generator-importer-tool/releases/latest)

2. Unpack the `addons/ninetailsrabbit.character-generator-importer-tool` folder into your `/addons` folder within the Godot project

3. Enable this addon within the Godot settings: `Project > Project Settings > Plugins`

To better understand what branch to choose from for which Godot version, please refer to this table:

|Godot Version|Character generator importer tool Branch|Character generator importer toolVersion|

|---|---|--|

|[![GodotEngine](https://img.shields.io/badge/Godot_4.3.x_stable-blue?logo=godotengine&logoColor=white)](https://godotengine.org/)|`4.3`|`1.x`|

|[![GodotEngine](https://img.shields.io/badge/Godot_4.4.x_stable-blue?logo=godotengine&logoColor=white)](https://godotengine.org/)|`main`|`1.x`|

# Features

- One tool node that only generates the animations and then can be deleted from the scene tree

- Create animated sprite and optionally the animation player for each spritesheet

- Generate all the animation frames from body parts to be able to customize the character inside Godot with resources

- Selectable Adult animations

- Selectable Kid animations

- Auto detect sprite size or set the values manually if you know the spritesheet size

- Support for importing individual spritesheets or all spritesheets contained within a folder

# Getting started

This is **an unofficial tool** that can be used as a plugin in Godot to speed up the process of creating animations for the character generator included in this asset https://limezu.itch.io/moderninteriors.

_There is no examples of spritesheet in the repository as it is a paid tool but the process is very simple I promise_

## Add the node to the scene

![importer_search](images/importer_search.png)

## Choose the spritesheets to import

![importer_properties](images/importer_properties.png)

- `Generate animations`: Tool button to start the generation of `AnimatedSprite2D` from the spritesheets

- `Clear animations`: Clear the animations generated in the scene tree

---

- `Create animation player`: When active creates an `AnimationPlayer` node for each `AnimatedSprite2D`, needed if you want to use them later in an `AnimationTree`.

- `Character spritesheet`: Select an individual character spritesheet .png to import from your project

- `Character spritesheet folder`: Select a folder to import all the character spritesheets inside

---

- `Input folder parts`: The folder where all the individual spritesheet parts to import are, animation frames will be generated as resources.

- `Output folder parts`: The folder where to generate the output animation frames created from the spritesheets found at `input_folder_parts`

## Select the parameters to import the spritesheets

![importer_search](images/importer_parameter.png)

- `Auto detect sprite size`: The tool auto detect the sprite size and character type _(Adult, Kid)_ to create the frames correctly

- `Sprite Size` _(not used if auto is active)_ The character generator tool gives you an option to save the spritesheets into `16x16`, `32x32` or `48x48`. Set that value here if you already know the size beforehand

- `Character type` _(not used if auto is active)_ The type of spritesheet to import `Adult` or `Kid`

- `Animation FPS`: The animation fps value for the generated `AnimatedSprite2D`

---

## Select the adult animations you want to include

![adult_animations](images/importer_adult_animations.png)

---

## Select the kid animations you want to include

![kid_animations](images/importer_kid_animations.png)

## Click the "Generate Animations" button

`Individual spritesheet`

![individual_spritesheet](images/individual_spritesheet.png)

![individual_spritesheet_frames](images/spritesheet_animations.png)

---

`Spritesheet folder`

![spritesheet_folder_generation](images/spritesheet_folder_generation.png)

# How to import spritesheet parts

The character generator tool saves all the spritesheet as separated body parts on the path:

`C:\Program Files (x86)\Character Generator 2.0\Character Pieces`

![generator_parts_folder](images/generator_parts_folder.png)

Set in the `CharacterGeneratorImporterTool` the property `input_folder_parts` with a folder that exists in your Godot project and then copy all the character pieces folders _(or only the parts you want)_ into it.

![input_folder_parts_set](images/input_folder_parts_set.png)

Set in the `CharacterGeneratorImporterTool` the property `output_folder_parts` with a folder that exists in your Godot project to generate the parts as animation frame resources

![importer_path_folders](images/importer_path_folders.png)

Click the `Generate Animations` button, this could take few seconds even using multiple threads so be patient if the editor freeze up for a moment.

⚠️ If you get an error when generate animations, you may have to restart the editor after importing all the parts ⚠️

![spritesheet_parts_final](images/spritesheet_parts_final.png)

---

![spritesheet_parts_final](images/spritesheet_parts_final_resource.png)