added support for custom art formatsgit add .

Author: kirjavascript

README.md

@@ -82,10 +82,12 @@ Mapping output can be configured to either reduce the number of tiles, or the nu
 
 Both methods of importing use CIEDE2000 nearest colour matching to the current palette.
 
-## Custom Mappings
+## Custom Formats
 
-As of version 1.0.0, Flex 2 supports a wider array of mapping formats and allows you to specify your own. 
+As of version 1.0.0, Flex 2 supports a wider array of formats and allows you to specify your own. 
 
-The base mapping formats are provided in the `scripts/` directory. These can be modified to suit whatever format you decide to come up with.
+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.
 
 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.

TODO

@@ -16,9 +16,8 @@ definition([
     many(art()),
 ])
 
-// provide custom art function
-// custom asm parser
 // custom palettes
+// custom asm parser
 
 /* https://unix.stackexchange.com/questions/585645/launch-an-application-by-a-double-click */
 // provide a custom definition, but have a default
@@ -33,8 +32,8 @@ definition([
 
 // formats to support
 
-// kid chameleon
 // crackers
+// kid chameleon
 // chaotix
 // s3k sonic saving
 // plane mappings / snap to

app/components/file/file-object.js

@@ -24,20 +24,22 @@ const compressionList = Object.keys(compressionFormats);
 export const FileObject = observer(({ obj }) => {
     scripts.length; // react to script updates
     const script = obj.format && runScript(obj.format);
+    const scriptSafe = script && !script.error;
 
     const { isAbsolute } = obj; // set in store/workspace
 
     const mappingsASM = extname(obj.mappings.path) === '.asm';
     const dplcsASM = extname(obj.dplcs.path) === '.asm';
     const linesLeft = obj.palettes.reduce((a, c) => a - c.length, 4);
 
-    const scriptDPLCs = script && !script.error && script.hasDPLCs;
+    const scriptDPLCs = scriptSafe && script.DPLCs;
+    const scriptArt = scriptSafe && script.art;
     const toggleDPLCs = () => (obj.dplcs.enabled = !obj.dplcs.enabled);
 
 
     function ioWrap(filePath, setError, e, cb) {
         setError();
-        if (script && !script.error && filePath) {
+        if (scriptSafe && filePath) {
             const done = SaveLoad.indicator(e);
             requestIdleCallback(async () => {
                 const path = isAbsolute
@@ -79,7 +81,9 @@ export const FileObject = observer(({ obj }) => {
     function loadArt(e) {
         ioWrap(obj.art.path, setArtError, e, async (path) => {
             const buffer = (await fs.readFile(path)).slice(obj.art.offset || 0);
-            const tiles = bufferToTiles(buffer, obj.art.compression);
+            const tiles = scriptArt
+                ? script.readArt(buffer)
+                : bufferToTiles(buffer, obj.art.compression);
             environment.tiles.replace(tiles);
         });
     }
@@ -89,7 +93,9 @@ export const FileObject = observer(({ obj }) => {
             if (obj.art.offset) {
                 throw new Error('Can only save art at offset 0');
             }
-            const tiles = tilesToBuffer(environment.tiles, obj.art.compression);
+            const tiles = scriptArt
+                ? script.writeArt(tiles)
+                : tilesToBuffer(environment.tiles, obj.art.compression);
             await fs.writeFile(path, tiles);
         });
     }
@@ -235,18 +241,22 @@ export const FileObject = observer(({ obj }) => {
                 <Item color="green">Art</Item>
                 <SaveLoad load={loadArt} save={saveArt} />
             </div>
-            <div className="menu-item">
-                <Item>Compression</Item>
-                <Select
-                    options={compressionList}
-                    store={obj.art}
-                    accessor="compression"
-                />
-            </div>
-            <div className="menu-item">
-                <Item>Offset</Item>
-                <Input store={obj.art} accessor="offset" isNumber />
-            </div>
+            {!scriptArt && (
+                <>
+                    <div className="menu-item">
+                        <Item>Compression</Item>
+                        <Select
+                            options={compressionList}
+                            store={obj.art}
+                            accessor="compression"
+                        />
+                    </div>
+                    <div className="menu-item">
+                        <Item>Offset</Item>
+                        <Input store={obj.art} accessor="offset" isNumber />
+                    </div>
+                </>
+            )}
             <ErrorMsg error={artError} />
             <FileInput
                 label="Art"

app/formats/scripts/run-script.js

@@ -119,13 +119,15 @@ export default catchFunc((file) => {
     const [write, setWrite] = useFunc();
     const [read, setRead] = useFunc();
 
+    const [artArgs, artFunc] = useDef();
     const [mappingArgs, mappingFunc] = useDef();
     const [dplcArgs, dplcFunc] = useDef();
 
     (new Function('Flex2', loadScript(file)))({
         ...constants,
         write,
         read,
+        art: artFunc,
         mappings: mappingFunc,
         dplcs: dplcFunc,
         offsetTable: makeOffsetTable({ read, write }),
@@ -285,11 +287,28 @@ export default catchFunc((file) => {
     const writeMappings = createWriter(mappingArgs[0]);
     const writeDPLCs = createWriter(dplcArgs[0]);
 
-    return {
+    const methods = {
+        mappings: true,
         readMappings,
         writeMappings,
-        hasDPLCs: !!dplcArgs[0],
-        readDPLCs,
-        writeDPLCs,
     };
+
+    if (dplcArgs[0]) {
+        Object.assign(methods, {
+            DPLCs: true,
+            readDPLCs,
+            writeDPLCs,
+        });
+    }
+
+    if (artArgs[0]) {
+        const [readArt, writeArt] = artArgs[0];
+        Object.assign(methods, {
+            art: true,
+            readArt,
+            writeArt,
+        });
+    }
+
+    return methods;
 });