npm - @jaeymo/toybox - Versions diffs - 1.0.0 → 1.0.1 - Mend

@jaeymo/toybox 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/README.md CHANGED Viewed

@@ -1 +1,33 @@
-# toybox
+# Toybox
+Toybox scans a Roblox asset hierarchy and produces a Rojo mapping so all of your assets are statically represented
+### Usage
+Run the CLI to generate a Rojo mapping from Roblox `.rbxlx` file:
+```console
+node dist/cli.js generate -i ./toybox-test.rbxlx -o ./default.project.json -f Assets
+```
+- `-i` / --input – Path to the `.rbxlx` file.
+- `-o` / --output – Path to your `.project.json` file.
+- `-f` / --folder – Name of the folder in ReplicatedStorage to map (default: Assets).
+### Example
+If your ReplicatedStorage contains:
+```JSON
+ReplicatedStorage
+└── Assets
+    ├── Models
+    └── SomeModel
+```
+Running the command would produce:
+```JSON
+"Asset": {
+    "$className": "Folder",
+    "Models": {
+        "$className": "Folder",
+        "SomeModel": {
+            "$className": "Model",
+        }
+    },
+}
+```

package/default.project.json CHANGED Viewed

@@ -1,34 +1,34 @@
-{
-    "name": "sometest",
-    "tree": {
-        "$className": "DataModel",
-        "ReplicatedStorage": {
-            "FilesHere": {
-                "$className": "Folder"
-            },
-            "Asset": {
-                "$className": "Folder",
-                "Models": {
-                    "$className": "Folder",
-                    "AnotherModel": {
-                        "$className": "Model",
-                        "SomePartName": {
-                            "$className": "Part"
-                        },
-                        "PrettyPrincess": {
-                            "$className": "Model"
-                        }
-                    }
-                },
-                "SomeModelName": {
-                    "$className": "Model"
-                }
-            }
-        },
-        "ServerScriptService": {
-            "files": {
-                "$className": "Folder"
-            }
-        }
-    }
+{
+    "name": "sometest",
+    "tree": {
+        "$className": "DataModel",
+        "ReplicatedStorage": {
+            "FilesHere": {
+                "$className": "Folder"
+            },
+            "Asset": {
+                "$className": "Folder",
+                "Models": {
+                    "$className": "Folder",
+                    "AnotherModel": {
+                        "$className": "Model",
+                        "SomePartName": {
+                            "$className": "Part"
+                        },
+                        "PrettyPrincess": {
+                            "$className": "Model"
+                        }
+                    }
+                },
+                "SomeModelName": {
+                    "$className": "Model"
+                }
+            }
+        },
+        "ServerScriptService": {
+            "files": {
+                "$className": "Folder"
+            }
+        }
+    }
 }

package/dist/cli.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js ADDED Viewed

@@ -0,0 +1,17 @@
+import { Command } from "commander";
+import { generateMapping } from "./generator.js";
+const program = new Command();
+program
+    .name("toybox")
+    .description("Generate rojo mappings from a Roblox directory")
+    .version("1.0.0");
+program
+    .command("generate")
+    .requiredOption("-i, --input <path>", "Input roblox directory")
+    .option("-f, --folder <name>", "Folder inside Roblox to map", "Asset")
+    .requiredOption("-o, --output <path>", "Path to .project.json")
+    .action((options) => {
+    generateMapping(options.input, options.output, options.folder);
+});
+program.parse(process.argv);
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,QAAQ,CAAC;KACd,WAAW,CAAC,gDAAgD,CAAC;KAC7D,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB,OAAO;KACF,OAAO,CAAC,UAAU,CAAC;KACnB,cAAc,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KAC9D,MAAM,CAAC,qBAAqB,EAAE,6BAA6B,EAAE,OAAO,CAAC;KACrE,cAAc,CAAC,qBAAqB,EAAE,uBAAuB,CAAC;KAC9D,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;IAChB,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;AACnE,CAAC,CAAC,CAAC;AAEP,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/generator.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export declare function buildTreeFromRbxlx(filePath: string, rootName: string): Record<string, any>;
+export declare function generateMapping(input: string, rojoPath: string, folderName: string): void;
+//# sourceMappingURL=generator.d.ts.map

package/dist/generator.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AA0EA,wBAAgB,kBAAkB,CAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgBrB;AAED,wBAAgB,eAAe,CAC3B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,QAwBrB"}

package/dist/generator.js ADDED Viewed

@@ -0,0 +1,97 @@
+import fs from "fs";
+import { XMLParser } from "fast-xml-parser";
+function getItemName(item) {
+    if (!item.Properties || !item.Properties.string)
+        return null;
+    const strings = Array.isArray(item.Properties.string)
+        ? item.Properties.string
+        : [item.Properties.string];
+    for (const str of strings) {
+        if (str.name === "Name") {
+            if (typeof str === "string")
+                return str;
+            if ("#text" in str)
+                return str["#text"];
+        }
+    }
+    return null;
+}
+function findFolderByName(item, name) {
+    const itemName = getItemName(item);
+    if (itemName === name)
+        return item;
+    const children = item.Item
+        ? Array.isArray(item.Item)
+            ? item.Item
+            : [item.Item]
+        : [];
+    for (const child of children) {
+        const found = findFolderByName(child, name);
+        if (found)
+            return found;
+    }
+    return null;
+}
+function traverse(item) {
+    const name = getItemName(item) || "Unnamed";
+    const node = {
+        name,
+        className: item.class,
+        children: {},
+    };
+    const children = item.Item
+        ? Array.isArray(item.Item)
+            ? item.Item
+            : [item.Item]
+        : [];
+    for (const child of children) {
+        const childNode = traverse(child);
+        node.children[childNode.name] = childNode;
+    }
+    return node;
+}
+function toRojo(node) {
+    const result = { $className: node.className };
+    if (node.children && Object.keys(node.children).length > 0) {
+        for (const [name, child] of Object.entries(node.children)) {
+            result[name] = toRojo(child);
+        }
+    }
+    return result;
+}
+export function buildTreeFromRbxlx(filePath, rootName) {
+    const xmlData = fs.readFileSync(filePath, "utf-8");
+    const parser = new XMLParser({
+        ignoreAttributes: false,
+        attributeNamePrefix: "",
+    });
+    const jsonObj = parser.parse(xmlData);
+    const items = Array.isArray(jsonObj.roblox.Item)
+        ? jsonObj.roblox.Item
+        : [jsonObj.roblox.Item];
+    const rootItem = findFolderByName({ Item: items }, rootName);
+    if (!rootItem)
+        throw new Error(`Folder '${rootName}' not found in .rbxlx`);
+    const rootNode = traverse(rootItem);
+    return { [rootNode.name]: toRojo(rootNode) };
+}
+export function generateMapping(input, rojoPath, folderName) {
+    if (!fs.existsSync(input)) {
+        console.error("Input file does not exist");
+        process.exit(1);
+    }
+    if (!fs.existsSync(rojoPath)) {
+        console.error("Rojo project file does not exist");
+        process.exit(1);
+    }
+    const project = JSON.parse(fs.readFileSync(rojoPath, "utf-8"));
+    if (!project.tree || !project.tree.ReplicatedStorage) {
+        console.error("Invalid Rojo project structure (is there a ReplicatedStorage?)");
+        process.exit(1);
+    }
+    const mapping = buildTreeFromRbxlx(input, folderName);
+    project.tree.ReplicatedStorage[folderName] = mapping[folderName];
+    fs.writeFileSync(rojoPath, JSON.stringify(project, null, 4));
+    console.log(`Mapping generated for '${folderName}'`);
+}
+//# sourceMappingURL=generator.js.map

package/dist/generator.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ5C,SAAS,WAAW,CAAC,IAAS;IAC1B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAE7D,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACjD,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM;QACxB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAE/B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,OAAO,GAAG,CAAC;YACxC,IAAI,OAAO,IAAI,GAAG;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAS,EAAE,IAAY;IAC7C,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEnC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI;QACtB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YACtB,CAAC,CAAC,IAAI,CAAC,IAAI;YACX,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjB,CAAC,CAAC,EAAE,CAAC;IACT,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC5B,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,QAAQ,CAAC,IAAS;IACvB,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAC5C,MAAM,IAAI,GAAc;QACpB,IAAI;QACJ,SAAS,EAAE,IAAI,CAAC,KAAK;QACrB,QAAQ,EAAE,EAAE;KACf,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI;QACtB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YACtB,CAAC,CAAC,IAAI,CAAC,IAAI;YACX,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjB,CAAC,CAAC,EAAE,CAAC;IACT,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,CAAC,QAAS,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC/C,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAC,IAAe;IAC3B,MAAM,MAAM,GAAwB,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;IACnE,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxD,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAkB,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAC9B,QAAgB,EAChB,QAAgB;IAEhB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QACzB,gBAAgB,EAAE,KAAK;QACvB,mBAAmB,EAAE,EAAE;KAC1B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEtC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5C,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI;QACrB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,QAAQ,uBAAuB,CAAC,CAAC;IAE3E,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpC,OAAO,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,KAAa,EACb,QAAgB,EAChB,UAAkB;IAElB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC3C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAClD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/D,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACnD,OAAO,CAAC,KAAK,CACT,gEAAgE,CACnE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,0BAA0B,UAAU,GAAG,CAAC,CAAC;AACzD,CAAC"}

package/package.json CHANGED Viewed

@@ -1,39 +1,42 @@
-{
-    "name": "@jaeymo/toybox",
-    "version": "1.0.0",
-    "publishConfig": {
-        "access": "public"
-    },
-    "description": "Toybox scans a Roblox hierarchy and produces a Rojo mapping so all of your assets are statically represented",
-    "homepage": "https://github.com/jaeymo/toybox#readme",
-    "bugs": {
-        "url": "https://github.com/jaeymo/toybox/issues"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/jaeymo/toybox.git"
-    },
-    "license": "MIT",
-    "author": "Jaeymo",
-    "type": "module",
-    "main": "index.js",
-    "scripts": {
-        "build": "tsc",
-        "dev": "ts-node src/cli.ts",
-        "clean": "rimraf dist"
-    },
-    "dependencies": {
-        "commander": "^14.0.3",
-        "fast-xml-parser": "^5.3.6",
-        "ts-node": "^10.9.2",
-        "typescript": "^5.9.3"
-    },
-    "devDependencies": {
-        "@eslint/js": "^10.0.1",
-        "@types/node": "^25.2.3",
-        "eslint": "^10.0.0",
-        "globals": "^17.3.0",
-        "rimraf": "^6.1.3",
-        "typescript-eslint": "^8.56.0"
-    }
-}
+{
+    "name": "@jaeymo/toybox",
+    "version": "1.0.1",
+    "publishConfig": {
+        "access": "public"
+    },
+    "description": "Toybox scans a Roblox hierarchy and produces a Rojo mapping so all of your assets are statically represented",
+    "homepage": "https://github.com/jaeymo/toybox#readme",
+    "bugs": {
+        "url": "https://github.com/jaeymo/toybox/issues"
+    },
+    "bin": {
+        "toybox": "dist/cli.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/jaeymo/toybox.git"
+    },
+    "license": "MIT",
+    "author": "Jaeymo",
+    "type": "module",
+    "main": "index.js",
+    "scripts": {
+        "build": "tsc",
+        "dev": "ts-node src/cli.ts",
+        "clean": "rimraf dist"
+    },
+    "dependencies": {
+        "commander": "^14.0.3",
+        "fast-xml-parser": "^5.3.6",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.9.3"
+    },
+    "devDependencies": {
+        "@eslint/js": "^10.0.1",
+        "@types/node": "^25.2.3",
+        "eslint": "^10.0.0",
+        "globals": "^17.3.0",
+        "rimraf": "^6.1.3",
+        "typescript-eslint": "^8.56.0"
+    }
+}