node-asset-studio-mod 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 StarFreedomX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+export declare const AssetTypes: readonly ["all", "tex2d", "tex2dArray", "sprite", "textasset", "monobehaviour", "font", "shader", "movietexture", "audio", "video", "mesh", "animator"];
+export type ExportMode = "extract" | "export" | "exportRaw" | "dump" | "info" | "live2d" | "splitObjects" | "animator";
+export type AssetType = typeof AssetTypes[number];
+export interface ExportAssetsDefaultConfig {
+    mode?: ExportMode;
+    cliPath?: string;
+    log?: boolean;
+    assetType?: AssetType | AssetType[];
+    group?: "none" | "type" | "container" | "containerFull" | "fileName" | "sceneHierarchy";
+    filenameFormat?: "assetName" | "assetName_pathID" | "pathID";
+    overwrite?: boolean;
+    logLevel?: "verbose" | "debug" | "info" | "warning" | "error";
+    logOutput?: "console" | "file" | "both";
+    imageFormat?: "none" | "jpg" | "png" | "bmp" | "tga" | "webp";
+    audioFormat?: "none" | "wav";
+    l2dGroupOption?: "container" | "fileName" | "modelName";
+    l2dMotionMode?: "monoBehaviour" | "animationClip";
+    l2dSearchByFilename?: boolean;
+    l2dForceBezier?: boolean;
+    fbxScaleFactor?: number;
+    fbxBoneSize?: number;
+    fbxAnimation?: "auto" | "skip" | "all";
+    fbxUVsAsDiffuse?: boolean;
+    filterByName?: string;
+    filterByContainer?: string;
+    filterByPathID?: string;
+    filterByText?: string;
+    filterWithRegex?: boolean;
+    blockinfoComp?: "auto" | "zstd" | "oodle" | "lz4" | "lzma";
+    blockComp?: "auto" | "zstd" | "oodle" | "lz4" | "lzma";
+    maxExportTasks?: number;
+    exportAssetList?: "none" | "xml";
+    assemblyFolder?: string;
+    unityVersion?: string;
+    decompressToDisk?: boolean;
+    notRestoreExtension?: boolean;
+    ignoreTypetree?: boolean;
+    loadAll?: boolean;
+}
+export declare class AssetExporter {
+    private defaultConfig;
+    constructor(defaultConfig?: ExportAssetsDefaultConfig);
+    private getDefaultCliPath;
+    exportAssets(input: string, output: string): Promise<void>;
+}
+export declare const exportAssets: any;
+export declare const createExporter: (config?: ExportAssetsDefaultConfig) => AssetExporter;

package/dist/index.js

@@ -0,0 +1,152 @@
+import { spawn } from "child_process";
+import path from "path";
+import fs from "node:fs";
+import os from "os";
+import { fileURLToPath } from "url";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export const AssetTypes = [
+    "all",
+    "tex2d",
+    "tex2dArray",
+    "sprite",
+    "textasset",
+    "monobehaviour",
+    "font",
+    "shader",
+    "movietexture",
+    "audio",
+    "video",
+    "mesh",
+    "animator",
+];
+const cliArgMap = {
+    overwrite: "-r",
+    logLevel: "--log-level",
+    logOutput: "--log-output",
+    imageFormat: "--image-format",
+    audioFormat: "--audio-format",
+    l2dGroupOption: "--l2d-group-option",
+    l2dMotionMode: "--l2d-motion-mode",
+    l2dSearchByFilename: "--l2d-search-by-filename",
+    l2dForceBezier: "--l2d-force-bezier",
+    fbxScaleFactor: "--fbx-scale-factor",
+    fbxBoneSize: "--fbx-bone-size",
+    fbxAnimation: "--fbx-animation",
+    fbxUVsAsDiffuse: "--fbx-uvs-as-diffuse",
+    filterByName: "--filter-by-name",
+    filterByContainer: "--filter-by-container",
+    filterByPathID: "--filter-by-pathid",
+    filterByText: "--filter-by-text",
+    filterWithRegex: "--filter-with-regex",
+    blockinfoComp: "--blockinfo-comp",
+    blockComp: "--block-comp",
+    maxExportTasks: "--max-export-tasks",
+    exportAssetList: "--export-asset-list",
+    assemblyFolder: "--assembly-folder",
+    unityVersion: "--unity-version",
+    decompressToDisk: "--decompress-to-disk",
+    notRestoreExtension: "--not-restore-extension",
+    ignoreTypetree: "--ignore-typetree",
+    loadAll: "--load-all",
+};
+export class AssetExporter {
+    defaultConfig;
+    constructor(defaultConfig = {}) {
+        this.defaultConfig = {
+            mode: "export",
+            log: true,
+            group: "container",
+            assetType: "all",
+            ...defaultConfig,
+        };
+    }
+    getDefaultCliPath() {
+        const base = path.resolve(__dirname, "../bin");
+        // 遍历 bin 下的所有子目录
+        const subdirs = fs.readdirSync(base, { withFileTypes: true })
+            .filter(d => d.isDirectory())
+            .map(d => path.join(base, d.name));
+        for (const dir of subdirs) {
+            const exe = os.platform() === "win32"
+                ? path.join(dir, "AssetStudioModCLI.exe")
+                : path.join(dir, "AssetStudioModCLI");
+            if (fs.existsSync(exe))
+                return exe;
+        }
+        return null;
+    }
+    async exportAssets(input, output) {
+        const cfg = this.defaultConfig;
+        const useLog = cfg.log ?? true;
+        if (!input)
+            throw new Error("missing input path");
+        if (!output)
+            throw new Error("missing output path");
+        if (!fs.existsSync(input))
+            throw new Error(`input not exist: ${input}`);
+        if (!fs.existsSync(output))
+            fs.mkdirSync(output, { recursive: true });
+        let cliPath = cfg.cliPath || this.getDefaultCliPath();
+        if (!cliPath)
+            throw new Error("Cannot find AssetStudioModCLI，please run `pnpm install` or check the folder /bin");
+        let types = "all";
+        if (cfg.assetType) {
+            types = Array.isArray(cfg.assetType) ? cfg.assetType.join(",") : cfg.assetType;
+            types.split(",").forEach((t) => {
+                if (!AssetTypes.includes(t))
+                    throw new Error(`unsupported type: ${t}`);
+            });
+        }
+        const args = [
+            wrapPath(input),
+            "-m", cfg.mode,
+            "-t", types,
+            "-g", cfg.group,
+            "-o", wrapPath(output),
+        ];
+        // 自动生成 args
+        for (const [key, cliName] of Object.entries(cliArgMap)) {
+            const val = cfg[key];
+            if (val === undefined || val === false)
+                continue;
+            if (typeof cliName === "string") {
+                // 布尔参数或有值参数
+                if (typeof val === "boolean")
+                    args.push(cliName);
+                else
+                    args.push(cliName, val.toString());
+            }
+            else {
+                // tuple
+                args.push(cliName[0], val.toString());
+            }
+        }
+        if (useLog)
+            console.log("exec:", cliPath, args.join(" "));
+        await new Promise((resolve, reject) => {
+            const proc = spawn(cliPath, args, { shell: true, windowsHide: true });
+            if (useLog) {
+                proc.stdout.on("data", (d) => process.stdout.write(d.toString()));
+                proc.stderr.on("data", (d) => process.stderr.write(d.toString()));
+            }
+            proc.on("error", reject);
+            proc.on("close", (code) => {
+                if (code === 0) {
+                    resolve();
+                }
+                else {
+                    reject(new Error(`AssetStudio CLI exit code: ${code}`));
+                }
+            });
+        });
+    }
+}
+function wrapPath(p) {
+    const resolved = path.resolve(p);
+    return `"${resolved}"`;
+}
+// 默认快捷导出
+const defaultExporter = new AssetExporter();
+export const exportAssets = defaultExporter.exportAssets.bind(defaultExporter);
+export const createExporter = (config) => new AssetExporter(config);

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "node-asset-studio-mod",
+  "version": "0.1.0",
+  "description": "Node.js adapter for AssetStudioMod CLI",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "scripts"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "keywords": [],
+  "author": "StarFreedomX",
+  "license": "MIT",
+  "dependencies": {
+    "@types/node": "^24.10.1",
+    "dotenv": "^17.2.3",
+    "unzipper": "^0.12.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "postinstall": "node scripts/download-cli.js",
+    "pub": "pnpm publish"
+  }
+}

package/readme.md

@@ -0,0 +1,114 @@
+# node-asset-studio-mod
+
+Node.js wrapper for [AssetStudioMod](https://github.com/aelurum/AssetStudio) CLI.
+
+other language:
+* [简体中文](readme_CN.md)
+
+## Environment
+
+**.NET 9 Runtime required**
+
+- **Windows**: [.NET Desktop Runtime 9.0](https://dotnet.microsoft.com/download/dotnet/9.0)
+- **Linux / Mac**: [.NET Runtime 9.0](https://dotnet.microsoft.com/download/dotnet/9.0)
+
+Ensure the runtime is installed before using this library.
+
+---
+
+## Installation
+
+```
+# using pnpm
+pnpm install node-asset-studio-mod
+
+# or npm
+npm install node-asset-studio-mod
+
+# or yarn
+yarn add node-asset-studio-mod
+```
+
+> During installation, the CLI binary will be downloaded automatically into `bin/` according to your platform.
+
+---
+
+## Usage
+
+### 1. Using the default exporter function
+
+```
+import { exportAssets } from "node-asset-studio-mod";
+
+const input = "path/to/assets/9.3.0.180";
+const output = "path/to/analysing/9.3.0.180";
+
+await exportAssets(input, output);
+```
+
+**Default options:**
+
+- `mode`: `"export"`
+- `log`: `true`
+- `group`: `"container"`
+- `assetType`: `"all"`
+- `cliPath`: automatically detected from `bin/`
+
+You can override options by passing a config object:
+
+```
+import { exportAssets } from "node-asset-studio-mod";
+
+await exportAssets(input, output, {
+assetType: ["tex2d", "sprite", "textasset"],
+overwrite: true,
+imageFormat: "png",
+logLevel: "info",
+});
+```
+
+---
+
+### 2. Using class instance for more control
+
+```
+import { AssetExporter } from "node-asset-studio-mod";
+
+const exporter = new AssetExporter({
+cliPath: "E:/myproject/bin/AssetStudioModCLI.exe", // optional
+mode: "export",
+assetType: ["tex2d", "sprite"],
+overwrite: true,
+});
+
+await exporter.exportAssets(input, output);
+```
+
+- You can create multiple instances with different configurations.
+- `cliPath` is optional; the library will automatically detect the binary in `bin/`.
+
+---
+
+### 3. Asset Types
+
+The supported asset types (matching TS `AssetTypes`) are:
+
+```
+"all", "tex2d", "tex2dArray", "sprite", "textasset", "monobehaviour",
+"font", "shader", "movietexture", "audio", "video", "mesh", "animator"
+```
+
+**Notes:**
+
+- `"all"` exports all types listed above.
+- You can specify multiple types using an array, e.g., `["tex2d", "sprite"]`.
+
+---
+
+### 4. Export Modes
+
+Supported modes (matching TS `ExportMode`):
+
+```
+"extract", "export", "exportRaw", "dump", "info", "live2d", "splitObjects", "animator"
+```

package/scripts/download-cli.js

@@ -0,0 +1,109 @@
+// scripts/download-cli.js
+import https from 'https';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { execSync, exec } from 'child_process';
+import { fileURLToPath } from 'url';
+import unzipper from 'unzipper';
+import { URL } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const binDir = path.join(__dirname, '../bin');
+const zipPath = path.join(binDir, 'cli.zip');
+
+async function checkDotnet() {
+    try {
+        const out = execSync('dotnet --list-runtimes').toString();
+        if (out.includes('Microsoft.NETCore.App 9.')) {
+            console.log('✔ 已检测到 .NET 9 Runtime');
+            return true;
+        }
+    } catch {}
+    console.log(`
+⚠ 检测到未安装 .NET 9 Runtime
+Windows (.NET Desktop): https://dotnet.microsoft.com/download/dotnet/9.0
+Linux/macOS (.NET Runtime): https://dotnet.microsoft.com/download/dotnet/9.0
+`);
+    return false;
+}
+
+function getDownloadURL() {
+    const base = 'https://github.com/aelurum/AssetStudio/releases/download/v0.19.0';
+
+    switch (os.platform()) {
+        case 'win32':
+            return `${base}/AssetStudioModCLI_net9_win64.zip`;
+        case 'darwin':
+            return `${base}/AssetStudioModCLI_net9_osx.zip`;
+        case 'linux':
+            return `${base}/AssetStudioModCLI_net9_linux64.zip`;
+    }
+    throw new Error('Unsupported platform');
+}
+
+function mirrorURLs(url) {
+    const u = new URL(url);
+    return [
+        `https://ghproxy.net/${url}`,
+        `https://download.fastgit.org${u.pathname}`,
+        `https://github.com.cnpmjs.org${u.pathname}`
+    ];
+}
+
+function download(url) {
+    return new Promise((resolve, reject) => {
+        console.log('Downloading:', url);
+
+        https.get(url, res => {
+            if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+                return resolve(download(res.headers.location)); // 处理302跳转
+            }
+            if (res.statusCode !== 200) {
+                return reject(new Error(`HTTP ${res.statusCode}`));
+            }
+
+            fs.mkdirSync(binDir, { recursive: true });
+            const file = fs.createWriteStream(zipPath);
+
+            res.pipe(file);
+            file.on('finish', () => file.close(resolve));
+            file.on('error', reject);
+        }).on('error', reject);
+    });
+}
+
+async function extract() {
+    console.log('Extracting...');
+    await fs.createReadStream(zipPath)
+        .pipe(unzipper.Extract({ path: binDir }))
+        .promise();
+}
+
+async function main() {
+    await checkDotnet();
+
+    const url = getDownloadURL();
+    const urls = [...mirrorURLs(url), url];
+
+    for (const u of urls) {
+        try {
+            console.log('尝试下载:', u);
+            await download(u);
+            console.log('✔ 下载成功:', u);
+            await extract();
+            console.log('AssetStudioModCLI 下载完成');
+            fs.unlinkSync(zipPath);
+            console.log('已清理临时文件 cli.zip');
+            return;
+        } catch (err) {
+            console.log(`✘ 失败: ${u}`);
+            console.log(err.message);
+        }
+    }
+
+    console.error('所有下载方式均失败，请手动下载');
+    process.exit(1);
+}
+
+main();