my changes for some plugins and 2048

2026-07-24 01:28:11 -07:00 · 2022-09-16 17:23:45 -04:00
parent 93d5839a51
commit 918c5a8439
25 changed files with 1260 additions and 39 deletions
@@ -0,0 +1,69 @@
+#####################################  
+encode.py  
+decode.py  
+iconencode.py  
+icondecode.py  
+
+A set of python3 scripts for processing the Flipper image files.  
+These work as-is but I am rolling in improvements.  
+#####################################  
+PREREQUISITES  
+  
+  
+You'll need heatshrink installed - a small embedded/RTOS compression and decompression library  
+You can get that here https://github.com/atomicobject/heatshrink  
+  
+#####################################  
+HOW TO USE  
+  
+##  
+# decode.  
+  
+Decode a .mb into .xbm:  
+decode.py input_image output_image [width] [height]   
+Dimensions are not stored in .bm so you need to specify  
+If you have the meta.txt available for the animation set the dimensions will be in here.  
+It may also be part of the directory name for the animation files as well.  
+  
+If you do not enter anything here it will assume 128x64. THIS WILL NOT ALWAYS BE CORRECT.  
+  
+##  
+# encode  
+Encode an .xbm file into .xb  
+encode.py input_image output_image  
+You will also get the image dimensions for use in meta.txt  
+That's it.  
+
+##  
+# iconencode
+Compress an icon asset from an XBM to a compressed char array ready to paste  
+Will assume dimensions of 128x64  
+Header works like this, you'll have to do this manually for now!
+ 
+Image Header Format Example
+0x01 = Compressed
+0x00 = Reserved Section
+0xa4,0x01 = 0x1a4, or, 420 - the size of the compressed array, minus this header. Just count the commas ;) 
+Rest of the data is char array output from heatshrink of the original XBM char array.
+Calculated Header: 0x01,0x00,0xa4,0x01
+from furi_hal_compress.c:
+typedef struct {
+    uint8_t is_compressed;
+    uint8_t reserved;
+    uint16_t compressed_buff_size;
+} FuriHalCompressHeader;
+
+
+##  
+# icondecode  
+Decompress an icon asset (as found in assets_icons.c and elsewhere)  
+icondecodepy input_image output_image [trim] [width] [height]  
+The icons in this file have a different header format. This will need to be trimmed.  
+A value of 8 for trim appears to be correct.  
+As with regular decoding, the width and height are not listed - but can be found in code/const/variable/etc names.  
+copy just the char array. The script does not care if the curly braces or semicolon are in place.  
+i.e. the following are all acceptable and equivalent.  
+{0x00,0x08,0x1C,0x3E,0x7F,};  
+{0x00,0x08,0x1C,0x3E,0x7F,}  
+0x00,0x08,0x1C,0x3E,0x7F  
+