sapdon 3.0.2 → 3.1.0

package/README.md

@@ -81,8 +81,9 @@ hello_sapdon/
 
 ## 📚 学习资源
 
-- [官方文档](https://docs.sapdon.org)
-- [示例模组仓库](https://github.com/Meteage/sapdon/examples)
+- [官方文档](./doc/)
+- [入门教程](./doc/hello_sapdon)
+- [示例模组仓库](./examples/)
 
 
 ## ❓ 常见问题

package/dist/cli/build.d.ts

@@ -0,0 +1,7 @@
+export function projectCanBuild(projectPath: any, projectName: any): boolean;
+export namespace scriptBundler {
+    let __projectPath: string;
+    function js(source: any, target: any): void;
+    function ts(source: any, target: any, tname?: string, sname?: string): Promise<void>;
+}
+export function buildProject(projectPath: string, projectName: string): Promise<void>;

package/dist/cli/build.js

@@ -0,0 +1,236 @@
+import path from 'path';
+import { pathNotExist, readFile, generateUUID, saveFile, copyFileSync, copyFolder, asyncImport } from "./utils.js";
+import { generateAddonClient } from './load.js';
+import { AddonManifestHeader, AddonManifestModule, AddonManifest, AddonManifestMetadata } from '../core/addon/manifest.js';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+import { rollup } from 'rollup';
+import commonjs from '@rollup/plugin-commonjs';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import ts from '@rollup/plugin-typescript';
+import { typescriptPaths as paths } from 'rollup-plugin-typescript-paths';
+import json from '@rollup/plugin-json';
+import { visualizer } from 'rollup-plugin-visualizer';
+import { syncDevFilesClient } from './dev-server/syncFiles.js';
+import { hmr } from './dev-server/hmr.js';
+import cp from 'child_process';
+// 获取当前文件的目录路径
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+//读取配置文件
+// const pathConfig = JSON.parse(readFile(path.join(__dirname, "./build.config")))
+const rollupIgnores = [
+    'rollup',
+    'typescript',
+    '@sapdon/core',
+    '@sapdon/cli',
+    '@minecraft',
+];
+//脚本打包器
+export const scriptBundler = {
+    __projectPath: path.join(__dirname, '../../'),
+    js: (source, target) => {
+        copyFolder(source, target);
+    },
+    //ts先通过rollup处理后再复制
+    ts: async (source, target, tname = 'index.js', sname = 'index.ts') => {
+        // console.log(source, target, tname)
+        const tmpFile = path.join(scriptBundler.__projectPath, '.tmp', `sapdon-${crypto.randomUUID()}.js`);
+        try {
+            const bundle = await rollup({
+                input: path.join(source, sname),
+                plugins: [
+                    paths(),
+                    nodeResolve({
+                        preferBuiltins: true
+                    }),
+                    //@ts-ignore
+                    ts({
+                        tsconfig: path.join(scriptBundler.__projectPath, 'tsconfig.json'),
+                    }),
+                    //@ts-ignore
+                    commonjs(),
+                    //@ts-ignore
+                    json(),
+                    // visualizer({ open: true }),  //可视化分析, 打包出问题取消注释这一行
+                ],
+                external(name) {
+                    for (const candidate of rollupIgnores) {
+                        if (name.includes(candidate)) {
+                            return true;
+                        }
+                    }
+                    return false;
+                }
+            });
+            await bundle.write({
+                file: tmpFile,
+                format: 'esm',
+            });
+            bundle.close();
+            fs.cpSync(tmpFile, path.join(target, tname));
+        }
+        catch (e) {
+            console.error(e);
+        }
+        finally {
+            fs.rmSync(tmpFile, {
+                recursive: true,
+                force: true
+            });
+        }
+    }
+};
+async function bundleScripts(projectPath, scriptPath, element) {
+    const sourcePath = path.join(projectPath, element.path);
+    const elementType = element.type || 'js';
+    scriptBundler.__projectPath = projectPath;
+    scriptBundler[elementType](sourcePath, scriptPath);
+}
+function preload(filePath) {
+    fs.appendFileSync(filePath, `
+        ;(async () => {
+            const { startDevServer } = await import('@sapdon/cli')
+            const { GRegistry, UISystemRegistry } = await import('@sapdon/core')
+            startDevServer(GRegistry, UISystemRegistry)
+        })();
+    `);
+}
+async function runOnChild(targetFilePath) {
+    const { promise, resolve } = Promise.withResolvers();
+    const child = cp.fork(targetFilePath, { stdio: 'inherit' });
+    child.once('message', message => {
+        if (message !== 'initialized') {
+            child.kill();
+        }
+        resolve();
+    });
+    await promise;
+}
+async function runScript(src) {
+    if (src.endsWith('.ts')) {
+        const randomName = crypto.randomUUID() + '.js';
+        const sourceDir = path.dirname(src);
+        const sourceFileName = src.replace(sourceDir, '');
+        const targetFilePath = path.join(sourceDir, randomName);
+        await scriptBundler.ts(sourceDir, sourceDir, randomName, sourceFileName);
+        preload(targetFilePath);
+        try {
+            await runOnChild(targetFilePath);
+        }
+        finally {
+            fs.rmSync(targetFilePath, { force: true });
+        }
+        return;
+    }
+    await runOnChild(src);
+}
+export function projectCanBuild(projectPath, projectName) {
+    console.log("开始构建项目");
+    console.log("项目路径：" + projectPath);
+    //检查项目是否存在
+    if (pathNotExist(projectPath)) {
+        console.log("项目不存在");
+        return false;
+    }
+    //检查项目是否有build.config文件
+    if (pathNotExist(path.join(projectPath, "build.config"))) {
+        console.log("项目没有build.config文件");
+        return false;
+    }
+    return true;
+}
+//构建项目
+/**
+ * `client`
+ *
+ * 在使用前使用 `projectCanBuild` 确保项目可以构建
+ * @param {string} projectPath
+ * @param {string} projectName
+ */
+export const buildProject = async (projectPath, projectName) => {
+    //读取build.config文件
+    const buildConfigPath = path.join(projectPath, "build.config");
+    const buildConfig = JSON.parse(readFile(buildConfigPath));
+    //console.log(buildConfig)
+    //读取mod.info文件
+    const modInfoPath = path.join(projectPath, "mod.info");
+    const modInfo = JSON.parse(readFile(modInfoPath));
+    const min_engine_version = versionStringToArray(modInfo.min_engine_version);
+    const buildDirPath = path.join(projectPath, buildConfig.defaultConfig.buildDir);
+    const buildBehDirPath = path.join(buildDirPath, `${projectName}_BP/`);
+    const buildResDirPath = path.join(buildDirPath, `${projectName}_RP/`);
+    //生成manifest.json文件
+    //判断manifest.json是否已经生成过了，生成过了就不用生成
+    const manifestPath = path.join(buildBehDirPath, "manifest.json");
+    if (pathNotExist(manifestPath)) {
+        const behManifest = generateBehManifest(modInfo.name, modInfo.description, modInfo.version, {
+            min_engine_version: min_engine_version,
+        }, buildConfig.defaultConfig.dependencies, buildConfig.defaultConfig.scriptEntry);
+        const resManifest = generateResManifest(modInfo.name, modInfo.description, modInfo.version, {
+            min_engine_version: min_engine_version,
+        }, []);
+        //BP
+        saveFile(path.join(buildBehDirPath, "manifest.json"), behManifest);
+        //RP
+        saveFile(path.join(buildResDirPath, "manifest.json"), resManifest);
+    }
+    //复制pack_icon.png
+    const packIconPath = path.join(projectPath, "pack_icon.png");
+    copyFileSync(packIconPath, path.join(buildBehDirPath, "pack_icon.png"));
+    copyFileSync(packIconPath, path.join(buildResDirPath, "pack_icon.png"));
+    const resources = buildConfig.resources;
+    resources.forEach(element => {
+        const sourcePath = path.join(projectPath, element.path);
+        copyFolder(sourcePath, buildResDirPath);
+    });
+    const scripts = buildConfig.scripts;
+    const scriptPath = path.join(buildBehDirPath, "scripts/");
+    for (const element of scripts) {
+        await bundleScripts(projectPath, scriptPath, element);
+    }
+    const absoluteModPath = path.join(projectPath, buildConfig.defaultConfig.buildEntry);
+    await runScript(absoluteModPath);
+    //只有当buildMode为development时才加载用户modjs文件
+    if (buildConfig.defaultConfig.buildMode === "development") {
+        //动态加载用户modjs文件
+        await generateAddonClient(absoluteModPath, buildDirPath, projectName);
+    }
+    syncDevFilesClient(projectPath, projectName);
+    if (buildConfig.useHMR === true) {
+        hmr(projectPath, projectName);
+    }
+};
+function versionStringToArray(versionString) {
+    // 使用 split 方法将字符串按 '.' 分割成数组
+    const parts = versionString.split('.');
+    // 使用 map 方法将每个部分转换为数字
+    const versionArray = parts.map(part => Number(part));
+    return versionArray;
+}
+const generateBehManifest = (name, description, version, options = {}, dependencies = [], entry) => {
+    console.log("开始生成behavior_packs/manifest.json");
+    console.log("Entry:", entry);
+    const header = new AddonManifestHeader((name + "_BP"), description, versionStringToArray(version), generateUUID(), options);
+    const module = new AddonManifestModule("行为模块", "data", generateUUID(), versionStringToArray(version));
+    const script_module = new AddonManifestModule("脚本模块", "script", generateUUID(), versionStringToArray(version));
+    if (entry) {
+        script_module.entry = entry;
+    }
+    const metadata = new AddonManifestMetadata(["@sapdon"], "MIT", {
+        "sapdon": ["1.0.0"]
+    }, "addon", "https://github.com/junjun260/sapdon");
+    const manifest = new AddonManifest(2, //格式版本
+    header, [module, script_module], dependencies, null, metadata);
+    return JSON.stringify(manifest, null, 2);
+};
+const generateResManifest = (name, description, version, options = {}, dependencies = []) => {
+    const header = new AddonManifestHeader((name + "_RP"), description, versionStringToArray(version), generateUUID(), options);
+    const module = new AddonManifestModule("资源模块", "resources", generateUUID(), versionStringToArray(version));
+    const metadata = new AddonManifestMetadata(["@sapdon"], "MIT", {
+        "sapdon": ["1.0.0"]
+    }, "addon", "https://github.com/junjun260/sapdon");
+    const manifest = new AddonManifest(2, //格式版本
+    header, [module], [], null, metadata);
+    return JSON.stringify(manifest, null, 2);
+};

package/dist/cli/dev-server/client.d.ts

@@ -0,0 +1,2 @@
+export function cliRequest(path: any, ...params: any[]): Promise<void>;
+export function writeAddon(modPath: any, buildPath: any, projectName: any): Promise<void>;

package/dist/cli/dev-server/client.js

@@ -0,0 +1,21 @@
+import { devServerConfig } from './config.js';
+import { ServerHandles } from './handles.js';
+const { port } = devServerConfig;
+export async function cliRequest(path, ...params) {
+    try {
+        await fetch(`http://localhost:${port}/${path}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(params)
+        });
+    }
+    catch (error) {
+        console.error(error);
+        console.error('尝试在构建脚本中使用 server.startDevServer() 启动开发服务器');
+    }
+}
+export async function writeAddon(modPath, buildPath, projectName) {
+    await cliRequest(ServerHandles.WRITE_ADDON, modPath, buildPath, projectName);
+}

package/dist/cli/dev-server/config.d.ts

@@ -0,0 +1,3 @@
+export namespace devServerConfig {
+    let port: number;
+}

package/dist/cli/dev-server/config.js

@@ -0,0 +1,3 @@
+export const devServerConfig = {
+    port: 49037
+};

package/dist/cli/dev-server/handles.d.ts

@@ -0,0 +1,4 @@
+export declare enum ServerHandles {
+    WRITE_ADDON = "write-addon",
+    WRITE_GAME_DEV = "write-dev"
+}

package/dist/cli/dev-server/handles.js

@@ -0,0 +1,5 @@
+export var ServerHandles;
+(function (ServerHandles) {
+    ServerHandles["WRITE_ADDON"] = "write-addon";
+    ServerHandles["WRITE_GAME_DEV"] = "write-dev";
+})(ServerHandles || (ServerHandles = {}));

package/dist/cli/dev-server/hmr.d.ts

@@ -0,0 +1 @@
+export function hmr(projectPath: any, projectName: any): void;

package/dist/cli/dev-server/hmr.js

@@ -0,0 +1,13 @@
+import fs from 'fs';
+import lodash from 'lodash';
+import { buildProject } from '../build.js';
+const debounce = lodash.debounce;
+export function hmr(projectPath, projectName) {
+    // fs.watch(projectPath, { recursive: true }, debounce(async (eventType, filename) => {
+    //     if (filename.endsWith('.js') || filename.endsWith('.ts')) {
+    //         process.stdout.write(`File ${filename} changed, reloading...\r`)
+    //         await buildProject(projectPath, projectName)
+    //         console.log(`Reloaded ${filename}`)
+    //     }
+    // }), 1000)
+}

package/dist/cli/dev-server/index.d.ts

@@ -0,0 +1,4 @@
+import { ServerHandles } from "./handles.js";
+import { server } from "./server.js";
+export declare function startDevServer(GRegistry: any, UIRegistry: any): void;
+export { server, ServerHandles, };

package/dist/cli/dev-server/index.js

@@ -0,0 +1,17 @@
+import { generateAddon } from "../load.js";
+import { ServerHandles } from "./handles.js";
+import { server } from "./server.js";
+import { syncDevFilesServer } from "./syncFiles.js";
+function startup(GRegistry, UIRegistry) {
+    server.bootstrap();
+    server.handle(ServerHandles.WRITE_ADDON, generateAddon(GRegistry, UIRegistry));
+    server.handle(ServerHandles.WRITE_GAME_DEV, syncDevFilesServer);
+}
+export function startDevServer(GRegistry, UIRegistry) {
+    if (server.isListening()) {
+        return;
+    }
+    startup(GRegistry, UIRegistry);
+    process.send('initialized');
+}
+export { server, ServerHandles, };

package/dist/cli/dev-server/server.d.ts

@@ -0,0 +1,14 @@
+import http from 'http';
+type ServerHandler = (...args: Transferable[]) => void;
+type HandlerInterceptor = (handler: ServerHandler) => ServerHandler;
+declare class DevelopmentServer {
+    readonly cliServerHandlers: Map<string, ServerHandler>;
+    listening: boolean;
+    isListening(): boolean;
+    bootstrap(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    handle(url: string, handler: ServerHandler): void;
+    getHandler(url: string): ServerHandler | undefined;
+    interceptHandler(url: string, interceptor: HandlerInterceptor): ServerHandler;
+}
+export declare const server: DevelopmentServer;
+export {};

package/dist/cli/dev-server/server.js

@@ -0,0 +1,59 @@
+import http from 'http';
+import { devServerConfig } from './config.js';
+const { port } = devServerConfig;
+class DevelopmentServer {
+    cliServerHandlers = new Map();
+    listening = false;
+    isListening() {
+        return this.listening;
+    }
+    bootstrap() {
+        this.listening = true;
+        const svr = http.createServer(async (req, res) => {
+            const handler = this.cliServerHandlers.get((req.url ?? '/').slice(1));
+            if (handler) {
+                try {
+                    const { promise, resolve, reject } = Promise.withResolvers();
+                    let buf = Buffer.alloc(0);
+                    req.on('data', chunk => buf = Buffer.concat([buf, chunk]));
+                    req.on('end', () => {
+                        try {
+                            resolve(JSON.parse(buf));
+                        }
+                        catch (error) {
+                            reject(error);
+                        }
+                    });
+                    await handler(...await promise);
+                }
+                catch (error) {
+                    console.error(error);
+                    res.writeHead(500);
+                    res.end();
+                    return;
+                }
+                res.writeHead(200);
+                res.end();
+            }
+            else {
+                res.writeHead(404);
+                res.end();
+            }
+        }).listen(port, () => console.log(`Dev Server listening on port ${port}`));
+        svr.on('error', () => this.listening = false);
+        return svr;
+    }
+    handle(url, handler) {
+        this.cliServerHandlers.set(url, handler);
+    }
+    getHandler(url) {
+        return this.cliServerHandlers.get(url);
+    }
+    interceptHandler(url, interceptor) {
+        const currentHandler = this.getHandler(url) ?? Function.prototype;
+        const newHandler = interceptor(currentHandler);
+        this.cliServerHandlers.set(url, newHandler);
+        return newHandler;
+    }
+}
+export const server = new DevelopmentServer();

package/dist/cli/dev-server/syncFiles.d.ts

@@ -0,0 +1,3 @@
+export function syncDevFilesClient(projectPath: any, projectName: any): Promise<void>;
+export function syncDevFilesServer(projectPath: any, projectName: any): Promise<void>;
+export function writeLib(projectPath: any): Promise<void>;

package/dist/cli/dev-server/syncFiles.js

@@ -0,0 +1,45 @@
+import { readFileSync } from "fs";
+import { cliRequest } from "./client.js";
+import { copyFolder, dirname } from "../utils.js";
+import path from "path";
+import fs from 'fs';
+import { ServerHandles } from "./handles.js";
+export async function syncDevFilesClient(projectPath, projectName) {
+    await cliRequest(ServerHandles.WRITE_GAME_DEV, projectPath, projectName);
+}
+export async function syncDevFilesServer(projectPath, projectName) {
+    const buildConfig = JSON.parse(readFileSync(path.join(projectPath, "build.config")));
+    const buildDir = path.join(projectPath, buildConfig.defaultConfig.buildDir);
+    const buildBehDirPath = path.join(buildDir, `${projectName}_BP`);
+    const buildResDirPath = path.join(buildDir, `${projectName}_RP`);
+    copyFolder(buildBehDirPath, path.join(buildConfig.mojangPath, "development_behavior_packs/", `${projectName}_BP/`));
+    copyFolder(buildResDirPath, path.join(buildConfig.mojangPath, "development_resource_packs/", `${projectName}_RP/`));
+}
+export async function writeLib(projectPath) {
+    const projectModules = path.join(projectPath, "node_modules");
+    const rootDir = path.join(dirname(import.meta), '../');
+    const corePath = path.join(rootDir, 'core');
+    const cliPath = path.join(rootDir, 'cli');
+    const ocPath = path.join(rootDir, 'oc');
+    const targetCorePath = path.join(projectModules, '@sapdon/core');
+    const targetCliPath = path.join(projectModules, '@sapdon/cli');
+    const targetOcPath = path.join(projectModules, '@sapdon/oc');
+    fs.cpSync(corePath, targetCorePath, { recursive: true, force: true });
+    fs.cpSync(cliPath, targetCliPath, { recursive: true, force: true });
+    fs.cpSync(ocPath, targetOcPath, { recursive: true, force: true });
+    fs.writeFileSync(path.join(targetCorePath, 'package.json'), JSON.stringify({
+        name: '@sapdon/core',
+        main: 'index.js',
+        version: '1.0.0',
+    }));
+    fs.writeFileSync(path.join(targetCliPath, 'package.json'), JSON.stringify({
+        name: '@sapdon/cli',
+        main: 'index.js',
+        version: '1.0.0',
+    }));
+    fs.writeFileSync(path.join(targetOcPath, 'package.json'), JSON.stringify({
+        name: '@sapdon/oc',
+        main: 'index.js',
+        version: '1.0.0',
+    }));
+}

package/dist/cli/index.d.ts

@@ -0,0 +1,20 @@
+import http from 'http';
+
+type ServerHandler = (...args: (Uint8Array & string)[]) => void | Promise<void>;
+type HandlerInterceptor = (handler: ServerHandler) => ServerHandler;
+declare class DevelopmentServer {
+    readonly cliServerHandlers: Map<string, ServerHandler>;
+    listening: boolean;
+    isListening(): boolean;
+    bootstrap(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    handle(url: string, handler: ServerHandler): void;
+    getHandler(url: string): ServerHandler | undefined;
+    interceptHandler(url: string, interceptor: HandlerInterceptor): ServerHandler;
+}
+declare const server: DevelopmentServer;
+
+declare namespace client {
+    function call(name: any, ...args: any[]): Promise<void>;
+}
+
+export { client, server as devServer };

package/dist/cli/index.js

@@ -0,0 +1,90 @@
+import http from 'http';
+
+const devServerConfig = {
+    port: 49037
+};
+
+const {
+    port: port$1
+} = devServerConfig;
+
+async function cliRequest(path, ...params) {
+    try {
+        await fetch(`http://localhost:${port$1}/${path}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(params)
+        });
+    } catch (error) {
+        console.error(error);
+        console.error('尝试在构建脚本中使用 server.startDevServer() 启动开发服务器');
+    }
+}
+
+const { port } = devServerConfig;
+class DevelopmentServer {
+    cliServerHandlers = new Map();
+    listening = false;
+    isListening() {
+        return this.listening;
+    }
+    bootstrap() {
+        this.listening = true;
+        const svr = http.createServer(async (req, res) => {
+            const handler = this.cliServerHandlers.get((req.url ?? '/').slice(1));
+            if (handler) {
+                try {
+                    const { promise, resolve, reject } = Promise.withResolvers();
+                    let buf = Buffer.alloc(0);
+                    req.on('data', chunk => buf = Buffer.concat([buf, chunk]));
+                    req.on('end', () => {
+                        try {
+                            resolve(JSON.parse(buf));
+                        }
+                        catch (error) {
+                            reject(error);
+                        }
+                    });
+                    await handler(...await promise);
+                }
+                catch (error) {
+                    console.error(error);
+                    res.writeHead(500);
+                    res.end();
+                    return;
+                }
+                res.writeHead(200);
+                res.end();
+            }
+            else {
+                res.writeHead(404);
+                res.end();
+            }
+        }).listen(port, () => console.log(`Dev Server listening on port ${port}`));
+        svr.on('error', () => this.listening = false);
+        return svr;
+    }
+    handle(url, handler) {
+        this.cliServerHandlers.set(url, handler);
+    }
+    getHandler(url) {
+        return this.cliServerHandlers.get(url);
+    }
+    interceptHandler(url, interceptor) {
+        const currentHandler = this.getHandler(url) ?? Function.prototype;
+        const newHandler = interceptor(currentHandler);
+        this.cliServerHandlers.set(url, newHandler);
+        return newHandler;
+    }
+}
+const server = new DevelopmentServer();
+
+const client = {
+    call: async (name, ...args) => {
+        return await cliRequest(name, ...args)
+    }
+};
+
+export { client, server as devServer };

package/dist/cli/init.d.ts

@@ -0,0 +1,9 @@
+export function initMojangPath(projectPath: any): void;
+export function initProject(projectPath: any, data: any): void;
+export function initNPMProject(projectPath: any, data: any): void;
+export function readPackageJson(dir: any): {
+    name: string;
+    description: any;
+    author: any;
+    version: any;
+} | null;