Relintai/texture_packer
1
0
Fork 0
mirror of https://github.com/Relintai/texture_packer.git synced 2024-11-12 10:15:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Relintai 2019-10-22 19:27:31 +02:00
parent 92e35aa199
commit b6530cdf15
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -2,7 +2,7 @@
This is a texture packer engine module, for the Godot Engine.
Internally it uses the legacy version of rectpack2D. (https://github.com/TeamHypersomnia/rectpack2D)
Internally it uses the legacy version of [rectpack2D](https://github.com/TeamHypersomnia/rectpack2D)
# Building
@ -10,41 +10,50 @@ Internally it uses the legacy version of rectpack2D. (https://github.com/TeamHyp
2. go into Godot's modules directory.
```
cd godot/modules/
```
3. clone this repository
```
git clone https://github.com/Relintai/texture_packer texture_packer
```
4. Build Godot. (https://docs.godotengine.org/en/latest/development/compiling/index.html)
4. Build Godot. [Tutorial](https://docs.godotengine.org/en/latest/development/compiling/index.html)
# Features and Usage
The module contains:
## TexturePacker
This is the class that can merge textures. Add every thexture xou want into it using it's API, and then call merge().
This is the class that can merge textures. Add every texture you want into it using it's API (add_texture()), and then call merge().
add_texture() will return an AtlasTexture, this is the texture you want to use in your classes. It is immediately usable, it will just contain the original texture. Calling merge() will change it, to point to the new (merged) texture.
Supports filters, custom background color, margins.
The keep_original_atlases option:
If you set this to true, and then add AtlasTextures, TexturePacker will change the added ones after the bake.
If you set this to true, and then add AtlasTexture(s), TexturePacker will change these ones (the ones you actually added)
after the bake.
You can use this for example to bake gui textures together, without changing the resources everywhere at runtime.
Note: add_texture() will also return the AtlasTextures that you add.
Note: I only recommend using this if your ui textures change during runtime, if they don't just make an atlas yourself.
Note: I only recommend using this if your ui textures need to change during runtime, if they don't you are better off making
the atlas yourself during development.
## TextureMerger
A Node that can bake textures for you. It uses TexturePacker internally.
It has an exposed Array, so you can assign textures to it in the editor.
## PackerImageResource
This is a simple Texture, which just cuntains an imported Image.
This is a simple Texture, which just contains an imported Image. It has no logic for drawing.
Useful for textures you only keep for baking, as this class will not register it's data into the VisualServer.
Useful for textures you only need for baking, as this class will not register it's data into the VisualServer.
The module also contains an editor plugin which can import textures as this Resource.
The module also contains an editor plugin which can import textures as `PackerImageResource` Resource.
To access it, click on a texture, switch to the import tab, and in the "Import As" Dropdown, select "Packer Image Recource".