Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2shady4u/godot-kra-psd-importer
GDNative wrapper for importing KRA- and PSD-files (Godot 3.1+)
https://github.com/2shady4u/godot-kra-psd-importer
gamedev godot godotengine
Last synced: 3 months ago
JSON representation
GDNative wrapper for importing KRA- and PSD-files (Godot 3.1+)
- Host: GitHub
- URL: https://github.com/2shady4u/godot-kra-psd-importer
- Owner: 2shady4u
- License: mit
- Created: 2020-03-04T13:01:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-07T20:19:36.000Z (almost 4 years ago)
- Last Synced: 2024-10-13T08:13:07.551Z (4 months ago)
- Topics: gamedev, godot, godotengine
- Language: C++
- Homepage:
- Size: 71.5 MB
- Stars: 61
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# godot-kra-psd-importer
**!!!DISCLAIMER !!! WORK IN PROGRESS**
GDNative wrapper for Importing KRA- and PSD-files into Godot 3.1+, making it possible to significantly speed up development. Additionally, it does not require any additional compilation or mucking about with build scripts.
Currently the plugin is only able to export to the PNG image format, but other formats might be added in the future.
This plugin is introduced/discussed in this [blogpost](https://www.tripthearkfantastic.com/ark-blog-thursday/our-foss-pipeline-backgrounds-from-draft-to-import/) for the upcoming game [Trip the Ark Fantastic](https://www.tripthearkfantastic.com/). Feel free to check it out if you are interested in Game development asset pipelines.
### Supported operating systems:
- Windows (Both KRA and PSD)
- Linux (Only KRA)
Not having PSD support on Linux is an unfortunate constraint of the [PSD Library SDK](https://molecular-matters.com/products_psd_sdk.html), a library that is used to make the PSD part of this plugin work. Efforts to make this library accessible in Linux are ongoing.
Also, an independent version (containing all of the same Kra-functionalities) is being hosted [here](https://github.com/2shady4u/kra_sdk) in the form of a C++ library.
### Table Of Contents
- [Roadmap](#roadmap)
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [Blatant self-advertisement](#blatant-self-advertisement)
- [Advanced usage instructions](#advanced-usage-instructions)
- [Build instructions](#build-instructions)
- [Additional documentation](#additional-documentation)
# Roadmap
- [x] Export to PNG
- [x] Support for Krita *.kra*-files
- [ ] Creation of a PackedScene that mirrors the PSD/KRA layer structure.
- [ ] Addition of metadata interface to create advanced functionalities. (parallax, tweening, ...)
Re-building Godot from scratch is **NOT** required, the proper way of installing this plugin is to either install it through the Asset Library or to just manually download the build files yourself.
### Godot Asset Library
The **Godot KRA/PSD Importer** is available through the official Godot Asset Library, and can be installed in the following way:
- Click on the 'AssetLib' button at the top of the editor.
- Search for 'godot-kra-psd-importer' and click on the resulting element.
- In the dialog pop-up, click 'Download'.
- Once the download is complete, click on the install button...
- Once more, click on the 'Install' button.
- Activate the plugin in the 'Project Settings/Plugins'-menu.
- All done!
### Manually
It's also possible to manually download the build files found in the [releases](https://github.com/2shady4u/godot-kra-psd-importer/releases) tab, extract them on your system and run the supplied demo-project. Make sure that Godot is correctly loading the *gdsqlite.gdns*-resource and that it is available in the *res://*-environment.
An example project, named "demo", can also be downloaded from the releases tab.
# Usage
After succesful activation of the plugin, an additional panel should have appeared next to the 'Import'-panel.
Several fields are available:
- **Raw File** (String ,default value='res://addons/godot-psd-importer/examples/PSDExample.psd')
Path to the **.kra*- or **.psd*-file that is to be imported into the engine.
- **Target Folder** (String, default='res://')
Folder to which the exported layers of the **.kra*- or **.psd*-file, as given by 'Raw File', will be saved.
- **Crop Layers to Canvas** (Bool, default=true)
Crop all layers of the raw file to the size of the canvas, making them the exact same size and removing any content that spills out of the canvas. Alternatively, the canvas size is ignored and the layer sizes are respected, resulting in exported images with possibly different sizes.
**IMPORTANT**: This option is currently unavailable for **.kra*-files and thus their image canvas size will always be ignored.
- **Mirror Universe** (Bool, default=true)
Creates a mirrored version of the raw file's layer structure. Current implementation is extremely elementary without any respect for groups or other more advanced functionalities.
After setting these fields correctly, the 'import'-button can be used to start the importing process.
Be sure to check console if any errors are spawned that cannot be decyphered by the import dock.
# Credits
This plugin makes heavy use of the [PSD Library SDK](https://molecular-matters.com/products_psd_sdk.html), without which the PSD-component of this plugin would be impossible. Alongside this, both the [zlib](https://github.com/madler/zlib) and [libpng](https://github.com/glennrp/libpng) repositories are included as submodules to, respectively, unzip the KRA archive and to export the raw data to the PNG image format.
Lastly, the [TinyXML-2](https://github.com/leethomason/tinyxml2) project is exploited to significantly simplify the parsing process of the 'maindoc.xml'-file as contained in the KRA archive.
This plugin was made by Gamechuck and is actively used during development of [Trip the Ark Fantastic](https://www.tripthearkfantastic.com/), a colourful game about societal and scientific themes set in the fabled Animal Kingdom. Be sure to check it out!
[](https://www.tripthearkfantastic.com/)
For more advanced usage, the binaries can also be called directly from GDScript without using the editor plugin at all.
This might be preferred in some more obscure/creative cases and is fully supported by the plugin.
## Variables
- **raw_file_path** (String ,default value='res://addons/godot-psd-importer/examples/PSDExample.psd')
Path to the *.kra- or *.psd-file that is to be exported. Both *res://* and *user://* keywords can be used to define the path.
- **target_folder_path** (String, default='res://')
Folder to which the exported layers of the raw file, as given by raw_file_path, will be saved. Both *res://* and *user://* keywords can be used to define the folder.
- **crop_to_canvas** (Boolean, default=true)
Either crop the layers to the canvas or ignore the canvas size entirely and respect the layer sizes.
- **mirror_universe** (Boolean, default=true)
If set to true, the importer will emit the "texture_created"-signal whenever a new texture is created. Check the implementation of the 'create_packed_scene.gd'-script for more information.
- **verbose_mode** (Boolean, default=false)
Setting verbose_mode on true results in an information dump in the Godot console that is handy for debugging purposes.
## Functions
- Boolean success = **export_all_layers()**
Exports the layers of a **.kra*- or **.psd*-file, as given by raw_file_path, to a target folder, as given by target_folder_path. Exported image format is either PNG or TGA as given by the export_type variable.
Instructions for building the **Godot KRA/PSD Importer** from scratch are available [here](docs/BUILD_INSTRUCTIONS.md).
The KRA-format is not that well-documented and thus this library attempts to reverse-engineer the format from scratch.
A small document discussing the KRA-format and its pecularities is available [here](docs/KRA_FORMAT.md).