DOCS: added hint about aseprite extension

vengi-voxel · Jun 15, 2024 · b27dfa0 · b27dfa0
1 parent e7f9aa6
commit b27dfa0
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 6 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -196,7 +196,7 @@ General:
    - Added support for particube `pcubes` and `3zh` support
    - Added support for Photoshop `ase` palette
    - Added support for Paintshop Pro (JASC) `pal` palette
-   - Extended support for the Gimp `gpl` palette format to support the AseSprite alpha channel extension
+   - Extended support for the Gimp `gpl` palette format to support the Aseprite alpha channel extension
    - Added support to collect anonymous metrics (disabled by default)
    - Added support to align all models in a scene - useful for rendering all models for an overview
    - Extended lua bindings

diff --git a/docs/Formats.md b/docs/Formats.md
@@ -70,6 +70,8 @@ Point cloud support for `ply` and `gtlf` is implemented, too.
 | Qubicle Palette                 | qsm       | X       |        |
 | RGB Palette                     | pal       | X       | X      |
 
+> The `gpl` format also supports the [Aseprite extension](https://github.com/aseprite/aseprite/blob/main/docs/gpl-palette-extension.md) for alpha values
+
 ## Images/textures
 
 | Name                        | Extension |

diff --git a/src/modules/palette/private/GimpPalette.cpp b/src/modules/palette/private/GimpPalette.cpp
@@ -4,7 +4,6 @@
 
 #include "GimpPalette.h"
 #include "core/Log.h"
-#include "core/StringUtil.h"
 #include "engine-config.h"
 
 namespace palette {
@@ -39,7 +38,7 @@ bool GimpPalette::load(const core::String &filename, io::SeekableReadStream &str
 		if (strcmp("GIMP Palette", line) == 0) {
 			continue;
 		}
-		// asesprite extension: https://github.com/aseprite/aseprite/blob/main/docs/gpl-palette-extension.md
+		// aseprite extension: https://github.com/aseprite/aseprite/blob/main/docs/gpl-palette-extension.md
 		if (strcmp("Channels: RGBA", line) == 0) {
 			alpha = true;
 		}

diff --git a/src/modules/palette/private/GimpPalette.h b/src/modules/palette/private/GimpPalette.h
@@ -9,7 +9,7 @@
 namespace palette {
 
 /**
- * Gimp format with ASESprite extension for alpha channels
+ * Gimp format with Aseprite extension for alpha channels
  *
  * @ingroup Formats
  */

diff --git a/src/modules/palette/private/PNGPalette.cpp b/src/modules/palette/private/PNGPalette.cpp
@@ -4,7 +4,6 @@
 
 #include "PNGPalette.h"
 #include "core/Log.h"
-#include "core/StringUtil.h"
 #include "image/Image.h"
 #include "palette/Palette.h"
 

diff --git a/src/modules/palette/private/PaletteFormat.cpp b/src/modules/palette/private/PaletteFormat.cpp
@@ -13,7 +13,6 @@
 #include "core/FourCC.h"
 #include "core/Log.h"
 #include "core/StringUtil.h"
-#include "io/FileStream.h"
 #include "io/FormatDescription.h"
 
 namespace palette {

diff --git a/src/tools/formatprinter/FormatPrinter.cpp b/src/tools/formatprinter/FormatPrinter.cpp
@@ -266,6 +266,9 @@ void FormatPrinter::printMarkdownTables() {
 		Log::printf("| %-31s | %-9s | X       | %c      |\n", desc.name.c_str(), desc.mainExtension().c_str(),
 			   save ? 'X' : ' ');
 	}
+
+	Log::printf("\n> The `gpl` format also supports the [Aseprite extension](https://github.com/aseprite/aseprite/blob/main/docs/gpl-palette-extension.md) for alpha values\n");
+
 	Log::printf("\n");
 	Log::printf("## Images/textures\n");
 	Log::printf("\n");