sapdon 2.0.0

package/examples/test/scripts/custom_components/cropComponent.js

@@ -0,0 +1,59 @@
+import { EquipmentSlot, GameMode, world } from "@minecraft/server";
+
+/**
+ * @param {number} min The minimum integer
+ * @param {number} max The maximum integer
+ * @returns {number} A random integer between the `min` and `max` parameters (inclusive)
+ */
+const randomInt = (min, max) => Math.floor(Math.random() * (max - min + 1)) + min;
+
+const maxGrowth = 3;
+
+/** @type {import("@minecraft/server").BlockCustomComponent} */
+const CustomCropGrowthBlockComponent = {
+    onRandomTick({ block }) {
+        const growthChance = 1 / 3;
+        if (Math.random() > growthChance) return;
+
+        const growth = block.permutation.getState("sapdon:block_variant_tag");
+        block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", growth + 1));
+    },
+    onPlayerInteract({ block, dimension, player }) {
+        if (!player) return;
+
+        const equippable = player.getComponent("minecraft:equippable");
+        if (!equippable) return;
+
+        const mainhand = equippable.getEquipmentSlot(EquipmentSlot.Mainhand);
+        if (!mainhand.hasItem() || mainhand.typeId !== "minecraft:bone_meal") return;
+
+        if (player.getGameMode() === GameMode.creative) {
+            // Grow crop fully
+            block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", maxGrowth));
+        } else {
+            let growth = block.permutation.getState("sapdon:block_variant_tag");
+
+            // Add random amount of growth
+            growth += randomInt(1, maxGrowth - growth);
+            block.setPermutation(block.permutation.withState("sapdon:block_variant_tag", growth));
+
+            // Decrement stack
+            if (mainhand.amount > 1) mainhand.amount--;
+            else mainhand.setItem(undefined);
+        }
+
+        // Play effects
+        const effectLocation = block.center();
+        dimension.playSound("item.bone_meal.use", effectLocation);
+        dimension.spawnParticle("minecraft:crop_growth_emitter", effectLocation);
+    },
+};
+
+export const CustomComponentRegister = () =>{
+    world.beforeEvents.worldInitialize.subscribe(({ blockComponentRegistry }) => {
+        blockComponentRegistry.registerCustomComponent(
+            "sapdon:crop_growth",
+            CustomCropGrowthBlockComponent
+        );
+    });
+}

package/examples/test/scripts/index.js

@@ -0,0 +1,101 @@
+import {Direction, world } from "@minecraft/server"
+import { CustomComponentRegister } from "./custom_components/cropComponent";
+
+
+CustomComponentRegister();
+
+const wireBlock = [];
+
+
+world.afterEvents.itemUseOn.subscribe((event) => {
+    const block = event.block;
+    const blockId = event.block.typeId;
+    const blockFace = event.blockFace;
+    if(blockId == "sapdon:wire"){
+        world.sendMessage("if wire");
+        switch(blockFace){
+            case Direction.North:
+                world.sendMessage("north");
+                //设置方块状态
+                block.setPermutation(
+                    block.permutation.withState("wire:north",1)
+                )
+                const north_block = block.north();
+                if(north_block.typeId == "sapdon:wire"){
+                    world.sendMessage("north is wire");
+                    north_block.setPermutation(
+                        north_block.permutation.withState("wire:south",1)
+                    )
+                }
+                break;
+            case Direction.South:
+                world.sendMessage("south");
+                block.setPermutation(
+                    block.permutation.withState("wire:south",1)
+                )
+                const south_block = block.south();
+                if(south_block.typeId == "sapdon:wire"){
+                    world.sendMessage("south is wire");
+                    south_block.setPermutation(
+                        south_block.permutation.withState("wire:north",1)
+                    )
+                }
+                break;
+            case Direction.East:
+                world.sendMessage("east");
+                block.setPermutation(
+                    block.permutation.withState("wire:east",1)
+                )
+                const east_block = block.east();
+                if(east_block.typeId == "sapdon:wire"){
+                    world.sendMessage("east is wire");
+                    east_block.setPermutation(
+                        east_block.permutation.withState("wire:west",1)
+                    )
+                }
+                break;
+            case Direction.West:    
+                world.sendMessage("west");
+                block.setPermutation(
+                    block.permutation.withState("wire:west",1)
+                )
+                const west_block = block.west();
+                if(west_block.typeId == "sapdon:wire"){
+                    world.sendMessage("west is wire");
+                    west_block.setPermutation(
+                        west_block.permutation.withState("wire:east",1)
+                    )
+                }
+                break;
+            case Direction.Up:
+                world.sendMessage("up");
+                block.setPermutation(
+                    block.permutation.withState("wire:top",1)
+                )
+                const up_block = block.above();
+                if(up_block.typeId == "sapdon:wire"){
+                    world.sendMessage("up is wire");
+                    up_block.setPermutation(
+                        up_block.permutation.withState("wire:bottom",1)
+                    )
+                }
+                break;
+            case Direction.Down:    
+                world.sendMessage("down");
+                block.setPermutation(
+                    block.permutation.withState("wire:bottom",1)
+                )
+                const down_block = block.below();
+                if(down_block.typeId == "sapdon:wire"){
+                    world.sendMessage("down is wire");
+                    down_block.setPermutation(
+                        down_block.permutation.withState("wire:top",1)
+                    )
+                }
+                break;
+        }
+    }
+    world.sendMessage("blockId:"+event.block.typeId);
+})
+
+

package/log.md

@@ -0,0 +1,75 @@
+### sapdon 日志
+1.修改了项目结构，将源码放入src/文件夹下，并添加示例文件夹examples/ [2024,1,15,15,27]
+
+
+
+### sapdon cli 脚手架工具日志
+时间 内容 版本[大版本，更新，修复]
+
+大版本 1
+
+更新
+1.添加物品，方块纹理支持，不用手写item_texture.json与terrain_texture.json [2025,1,15,21,17]
+2.添加了对物品类方块类的生成支持 [2024,1,16,0,16]
+3.生成文件名加入命名空间作为前缀 [2024,1,17,20,42]
+4.添加了对可附着物类的生成支持 [2024,1,18,22,14]
+5.修改了load.js里生成的逻辑，取消分别生成而采用统一注册生成 [2024,1,23,13,38]
+6.将输出游戏的路径加入值cli文件夹下build.config文件下方便用户根据自己的喜欢设置 [2025,1,25,18,01]
+7.添加了模组build.config的buildMode选项，当模式为debug时,cli将不会再对main.mjs进行读取，构建，而是直接将dev文件夹输出到游戏目录 [2025,2,7,10,55]
+
+修复
+1.修复构建后导入mc时，addon包无法被识别情况 [2025,1,15,17,34] 
+2.修复物品显示bug [2024,1,16,11,49]
+3.修改了输出文件夹的文件夹关系错乱问题  [2025,1,25,17,35]
+
+
+
+
+### sapdon core 核心库日志
+
+大版本 1
+
+更新
+1.添加了基础物品的封装 [2024,1,16,0,16]
+2.添加了一些基础物品组件 [2024,1,16,11,49]
+3.添加了BasicBlock类以对基础方块进行封装 [2024,1,16,12,44]
+4.添加了常用的物品组件方法 [2024,1,16,20,8]
+5.添加了方块的全部组件方法 [2024,1,16,18,0]
+6.添加了基础食物的封装类 [2024,1,17,16,42]
+7.添加了Block类封装创建一般方块的方法 [2024,1,17,20,10]
+8.添加了AddonClientEntityDescription类及其AddonAttachableDescription类  [2024,1,17,21,14]
+9.添加了Attachable类封装创建一般可附着物的方法 [2024,1,18,22,14]
+10.添加了实体接口支持 [2024,1,21,15,27]
+11.添加了实体基类BasicEntity封装  [2024,1,21,22,45]
+12.添加了实体部分常用组件及其行为组件  [2024,1,21,22,45]
+13.添加了熔炉配方和工作台配方组件 [2024,1,22,1,0]
+14.添加了GRegister类用于告知脚手架工具如何生成文件 [2024,1,23,13,40]
+15.添加了可抛掷物类 [2024,1,23,19,13]
+16.添加了原版实体继承类，方便直接继承原版的需要 [2025,1,25,17,49]
+17.添加了可旋转方块类   [2025,1,26,23,53]
+18.添加了带模型的方块类 [2025,2,1,0,20]
+19.添加了矿石特征类   [2025,2,5,15,41]
+20.添加了特征规则类   [2025,2,5,15,41]
+21.添加了矿石类   [2025,2,5,19,41]
+22.添加了个管理纹理的类，以支持自定义纹理 [2025,2,9,18,55]
+
+修复
+1.重写AddonClientEntityDescription类及其AddonAttachableDescription类以更方便地使用 [2024,1,18,22,14]
+2.修改ClientEntity类以更方便使用 [2024,1,21,22,45]
+3.修复GRegister的一些bug
+
+
+大版本 2
+对JsonUI进行了大幅度支持
+
+更新
+1.添加了UISystem类用于管理ui文件
+2.添加了UIElenment类用于创建基础UI元素
+3.添加了Control,DataBinding,Factory,Input,Layout,Sprite属性库
+4.添加了Panel类，用以创建面板元素
+5.添加了Image类，用以创建图片元素
+6.添加了ServerFormSystem类，为脚本调用UI做准备
+7.添加了SerVerUISystem类，用以提供自定义UI注册 [2025,2,15,16,40]
+
+修复
+1.修复了自定义UI注册系统显示bug [2025,2,16,22,08]

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "sapdon",
+  "version": "2.0.0",
+  "main": "src/core/index.js",
+  "scripts": {
+    "sapdon": "node src/cli/index.js",
+    "create": "node src/cli/index.js create",
+    "build": "node src/cli/index.js build"
+  },
+  "keywords": [
+    "bedrock",
+    "tools",
+    "addon"
+  ],
+  "author": "Meteage",
+  "license": "ISC",
+  "type": "module",
+  "bin": {
+    "sapdon": "src/cli/index.js"
+  },
+  "description": "The Sapdon is a Node.js toolkit designed for building Bedrock Edition Minecraft addon packs.",
+  "dependencies": {
+    "commander": "^13.0.0",
+    "download-git-repo": "^3.0.2",
+    "inquirer": "^12.3.1",
+    "ora": "^8.1.1"
+  },
+  "devDependencies": {
+    "@minecraft/server": "^1.18.0-beta.1.21.60-preview.28"
+  }
+}

package/src/cli/build.config

@@ -0,0 +1,4 @@
+{
+    "mojangPath": "C:/Users/ASUS/AppData/Local/Packages/Microsoft.MinecraftUWP_8wekyb3d8bbwe/LocalState/games/com.mojang",
+    "mojangBetaPath":"./"
+}

package/src/cli/build.js

@@ -0,0 +1,211 @@
+import path from 'path';
+import { checkPath, readFile, generateUUID ,saveFile,copyFileSync, copyFolder} from "./utils.js"
+import { loadAndExecuteMod } from './load.js';
+
+import { 
+    AddonManifestHeader, 
+    AddonManifestModule, 
+    AddonManifest, 
+    AddonManifestMetadata
+} from '../core/addon/manifest.js';
+
+import { fileURLToPath } from 'url';
+
+// 获取当前文件的目录路径
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+//读取配置文件
+const pathConfig = JSON.parse(readFile(path.join(__dirname,"./build.config")));
+
+//构建项目
+export const buildProject = (projectPath,projectName) => {
+   console.log("开始构建项目");
+   console.log("项目路径：" + projectPath);
+    //检查项目是否存在
+    if(checkPath(projectPath)) {
+        console.log("项目不存在");
+        return;
+    }
+    //检查项目是否有build.config文件
+    if(checkPath(path.join(projectPath,"build.config"))) {
+        console.log("项目没有build.config文件");
+        return;
+    }
+
+    //读取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(checkPath(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);
+    });
+
+    //复制scripts文件夹
+    const scripts = buildConfig.scripts;
+    const scriptPath = path.join(buildBehDirPath,"scripts/");
+    scripts.forEach(element => {
+        const sourcePath = path.join(projectPath,element.path);
+        copyFolder(sourcePath,scriptPath);
+    });
+
+    
+
+    //只有当buildMode为development时才加载用户modjs文件
+    if(buildConfig.defaultConfig.buildMode === "development"){
+         //动态加载用户modjs文件
+        loadAndExecuteMod(path.join(projectPath,buildConfig.defaultConfig.buildEntry),buildDirPath,projectName);
+    }
+   
+    //延迟1s
+    setTimeout(()=>{
+        //将编译好的文件夹拷贝至mc
+        //console.log(path.join(pathConfig.mojangPath,`development_behavior_packs/${projectName}_BP/`));
+        copyFolder(buildBehDirPath,path.join(pathConfig.mojangPath,"development_behavior_packs/",`${projectName}_BP/`));
+        copyFolder(buildResDirPath,path.join(pathConfig.mojangPath,"development_resource_packs/",`${projectName}_RP/`));
+    },1000);
+
+}
+
+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/src/cli/index.js

@@ -0,0 +1,150 @@
+#!/usr/bin/env node
+import {program} from 'commander';
+import inquirer from 'inquirer';
+import path from 'path';
+
+import {initNPMProject, initProject,readPackageJson} from './init.js';
+import {buildProject} from './build.js';
+import {readFile} from "./utils.js";
+import fs from "fs";
+import {fileURLToPath} from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+process.removeAllListeners('warning');
+
+// 额外添加的init方法
+program.command("init").description("初始化一个基于NodeJS的项目").action(() => {
+    const currentDir = process.cwd();
+    const packageJsonPath = path.join(currentDir, 'package.json');
+    let packageJsonData;
+    if (!fs.existsSync(packageJsonPath)) {
+        console.error("没有找到package.json文件，请使改用create命令进行创建。");
+        return;
+    }
+
+    try {
+        packageJsonData = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+    } catch (error) {
+        console.error("读取package.json文件时出错:", error);
+        console.log("请使改用create命令进行创建。")
+        return;
+    }
+
+    // 添加或更新scripts字段
+    packageJsonData.scripts = {
+        ...packageJsonData.scripts,
+        init: "sapdon init",
+        pack: "sapdon pack",
+        config: "sapdon config"
+    };
+
+    try {
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJsonData, null, 2), 'utf-8');
+    } catch (error) {
+        console.error("写入package.json文件时出错:", error);
+        return;
+    }
+
+    inquirer.prompt([
+        {
+            type: "input",
+            name: "min_engine_version",
+            message: "最低引擎版本:",
+            default: "1.19.50"
+        }
+    ]).then((answers) => {
+        initNPMProject(currentDir, {...readPackageJson(currentDir), ...answers});
+        console.log("请使用命令sapdon config配置框架的build.config文件。");
+    })
+});
+
+program.command("create <project-name>").description("Create a new project").action((projectName) => {
+    inquirer.prompt([
+        {
+            type: "input",
+            name: "name",
+            message: "Project Name:",
+            default: path.basename(projectName)
+        },
+        {
+            type: "input",
+            name: "description",
+            message: "Project Description:",
+            default: "A new sapdon project"
+        },
+        {
+            type: "input",
+            name: "author",
+            message: "Author Name:",
+            default: "Sapdon"
+        },
+        {
+            type: "input",
+            name: "version",
+            message: "Project Version:",
+            default: "1.0.0"
+        },
+        {
+            type: "input",
+            name: "min_engine_version",
+            message: "Minimum Engine Version:",
+            default: "1.19.50",
+        }
+    ]).then((answers) => {
+        const projectPath = path.join(process.cwd(), projectName);
+        console.log('项目路径:', projectPath);
+        initProject(projectPath, answers);
+    });
+});
+
+program.command("build <project-name>").description("Build the project").action((projectName) => {
+    console.log("Building the project...");
+    const projectPath = path.join(process.cwd(), projectName);
+    buildProject(projectPath, path.basename(projectName));
+});
+
+// pack 命令
+program.command("pack").description("Pack the current project").action(() => {
+    console.log("Packing the current project...");
+    const projectPath = process.cwd();
+    buildProject(projectPath, path.basename(projectPath));
+});
+
+// 配置build.config文件的命令
+program.command("config").description("Configure build.config file").action(() => {
+    const buildConfigPath = path.join(__dirname, "./build.config");
+    let buildConfigData;
+
+    try {
+        buildConfigData = JSON.parse(readFile(buildConfigPath));
+    } catch (error) {
+        console.error("读取build.config文件时出错:", error);
+        return;
+    }
+
+    inquirer.prompt([
+        {
+            type: "input",
+            name: "mojangPath",
+            message: "Mojang Path (must end with LocalState/games/com.mojang/):",
+            default: buildConfigData.mojangPath || "./"
+        },
+        {
+            type: "input",
+            name: "mojangBetaPath",
+            message: "Mojang Beta Path (must end with LocalState/games/com.mojang/):",
+            default: buildConfigData.mojangBetaPath || "./"
+        }
+    ]).then((answers) => {
+        try {
+            fs.writeFileSync(buildConfigPath, JSON.stringify({...buildConfigData, ...answers}, null, 2), 'utf-8');
+            console.log("build.config文件已更新。");
+        } catch (error) {
+            console.error("写入build.config文件时出错:", error);
+        }
+    })
+});
+
+program.parse(program.argv);