Custom palettes allowed

Author: kirjavascript

CHANGELOG

@@ -1,8 +1,9 @@
 # Changelog
 
 ## [1.0.0]
-- New mapping/DPLC engine
-    - Real custom mappings
+- New engine
+    - Real custom mappings & DPLCs
+    - Custom art formats (including compression)
     - Sonic 2 Special Stage added [#21](/../../issues/21)
     - Sonic 3&K Sonic/Supersonic partial support
 - New ASM parser/writer

README.md

@@ -88,6 +88,6 @@ As of version 1.0.0, Flex 2 supports a wider array of formats and allows you to
 
 The base formats are provided in the `scripts/` directory. These can be modified to suit whatever format you decide to come up with.
 
-You can provide custom mapping formats, DPLCs formats, art formats (including compression) and palette formats.
+You can provide custom mapping formats, DPLCs formats, art formats (including compression), and palette formats.
 
 The definition file format is currently undocumented, and still being expanded on. If you have a request to add support for a new disassembly, or just want more information on the format - open an issue on github with your request.

app/components/file/file-object.js

@@ -34,9 +34,9 @@ export const FileObject = observer(({ obj }) => {
 
     const scriptDPLCs = scriptSafe && script.DPLCs;
     const scriptArt = scriptSafe && script.art;
+    const scriptPalettes = scriptSafe && script.palettes;
     const toggleDPLCs = () => (obj.dplcs.enabled = !obj.dplcs.enabled);
 
-
     function ioWrap(filePath, setError, e, cb) {
         setError();
         if (scriptSafe && filePath) {
@@ -116,9 +116,16 @@ export const FileObject = observer(({ obj }) => {
                 obj.dplcs.enabled &&
                 environment.dplcs.length < mappings.sprites.length
             ) {
-                environment.dplcs.push(...Array.from({
-                    length: mappings.sprites.length - environment.dplcs.length,
-                }, () => []));
+                environment.dplcs.push(
+                    ...Array.from(
+                        {
+                            length:
+                                mappings.sprites.length -
+                                environment.dplcs.length,
+                        },
+                        () => [],
+                    ),
+                );
             }
         });
     }
@@ -130,8 +137,7 @@ export const FileObject = observer(({ obj }) => {
             if (!mappingsASM) {
                 await fs.writeFile(path, writeBIN(mappings));
             } else {
-                const label =
-                    obj.mappings.label || 'Mappings';
+                const label = obj.mappings.label || 'Mappings';
                 await fs.writeFile(path, writeASM(label, mappings));
             }
         });
@@ -159,8 +165,7 @@ export const FileObject = observer(({ obj }) => {
             if (!dplcsASM) {
                 await fs.writeFile(path, writeBIN(dplcs));
             } else {
-                const label =
-                    obj.dplcs.label || 'DPLCS';
+                const label = obj.dplcs.label || 'DPLCS';
                 await fs.writeFile(path, writeASM(label, dplcs));
             }
         });
@@ -180,12 +185,11 @@ export const FileObject = observer(({ obj }) => {
                 const path = isAbsolute
                     ? palPath
                     : workspace.absolutePath(palPath);
-                buffersToColors([
-                    {
-                        buffer: await fs.readFile(path),
-                        length,
-                    },
-                ]).forEach((line) => {
+
+                (scriptPalettes ? script.readPalettes : buffersToColors)({
+                    buffer: await fs.readFile(path),
+                    length,
+                }).forEach((line) => {
                     if (cursor < 4) {
                         environment.palettes[cursor] = line;
                         cursor++;
@@ -208,7 +212,9 @@ export const FileObject = observer(({ obj }) => {
                     ? palPath
                     : workspace.absolutePath(palPath);
 
-                const chunk = colorsToBuffers(
+                const chunk = (scriptPalettes
+                    ? script.writePalettes
+                    : colorsToBuffers)(
                     environment.palettes,
                     cursor,
                     cursor + length,

app/formats/palette.js

@@ -15,23 +15,22 @@ export function hexToMDHex(color) {
         .join``;
 }
 
-export function buffersToColors(list) {
+export function buffersToColors({ buffer, length }) {
     let colors = [];
-    list.forEach(({buffer, length}) => {
-        const data = Uint8Array.from(buffer);
-        for (let i = 0; i < length * 32; i+=2) {
-            if (data.length <= i) {
-                throw new Error('Trying to load more palettes than exist');
-            }
-            const [b, gr] = [
-                data[i].toString(16),
-                data[i+1].toString(16).padStart(2, '0'),
-            ];
-            const [g, r] = [...gr];
-            colors.push(`#${r}${g}${b}`);
 
+    const data = Uint8Array.from(buffer);
+    for (let i = 0; i < length * 32; i+=2) {
+        if (data.length <= i) {
+            throw new Error('Trying to load more palettes than exist');
         }
-    });
+        const [b, gr] = [
+            data[i].toString(16),
+            data[i+1].toString(16).padStart(2, '0'),
+        ];
+        const [g, r] = [...gr];
+        colors.push(`#${r}${g}${b}`);
+
+    }
 
     return chunk(colors, 16).splice(0, 4);
 }

app/formats/scripts/run-script.js

@@ -122,6 +122,7 @@ export default catchFunc((file) => {
     const [artArgs, artFunc] = useDef();
     const [mappingArgs, mappingFunc] = useDef();
     const [dplcArgs, dplcFunc] = useDef();
+    const [paletteArgs, paletteFunc] = useDef();
 
     (new Function('Flex2', loadScript(file)))({
         ...constants,
@@ -310,5 +311,15 @@ export default catchFunc((file) => {
         });
     }
 
+    if (paletteArgs[0]) {
+        const [readPalettes, writePalettes] = paletteArgs[0];
+        Object.assign(methods, {
+            palettes: true,
+            readPalettes,
+            writePalettes,
+        });
+    }
+
+
     return methods;
 });