sapdon 2.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 junjun260
+
+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/README.md

@@ -0,0 +1,26 @@
+Sapdon框架是一个功能强大的JavaScript框架，专门设计用于开发基岩版的模组。该框架致力于统一开发形式和简化开发过程，使开发者能够更轻松地创建基岩版的模组。
+
+使用Sapdon框架，开发者能够充分利用JavaScript语言的灵活性和易用性，快速编写出高效且功能丰富的基岩版模组。框架提供了丰富的API和工具,帮助开发者处理模组的生命周期、实体的创建、方块的定义、物品的添加和食谱的制作等功能。
+
+该框架的一个主要优势是其自动编译功能，它可以将开发者编写的代码自动转换为mcaddon包，使模组的发布和分享变得非常简便。开发者只需专注于编写模组的逻辑和功能，不需要手动处理繁琐的打包和转换过程。
+
+此外，Sapdon框架还提供了全面的文档和示例代码，帮助开发者快速上手并解决在开发过程中遇到的问题。同时，框架还积极维护更新，以确保与最新版本的基岩版游戏保持兼容性。
+
+总而言之，Sapdon框架是一个强大而便捷的工具，为开发者提供了简化基岩版模组开发的解决方案。无论是初学者还是有经验的开发者，都可以通过使用这个框架，快速构建出令人印象深刻的基岩版模组。
+
+官方QQ群： 810904181  
+
+### sapdon cli 命令行工具
+功能：
+1.创建新项目 
+    sapdon create <project_name> 在当前目录下创建新项目文件夹，并初始化项目文件
+
+2.编译项目 
+    sapdon build <project_name> 将指定项目编译为mcaddon包，并输出到指定目录
+
+### sadon core 核心模块
+提供API接口，方便其他模块调用
+采用注册方式
+
+### 新特性
+更适合npm的体质，可以读取nodejs的项目信息作为基础配置。

package/doc/api.md

@@ -0,0 +1,128 @@
+# 物品类 (Item) 和 ItemAPI 工厂函数 API 文档
+
+## 类描述
+`Item` 类用于创建一个物品对象，该对象可以包含多种组件，并且可以转换为 JSON 格式，用于在特定的游戏中定义物品。`ItemAPI` 是一个工厂函数集合，用于简化物品的创建过程，支持创建普通物品、食物、可附着物品以及胸甲护甲等。
+
+## Item 类
+
+### 构造函数
+### `constructor(identifier, category, texture, options = {})`
+创建一个新的物品实例。
+
+#### 参数
+- `identifier` (string): 物品的唯一标识符。
+- `category` (string): 物品所属的菜单栏分类，可选值包括："construction", "nature", "equipment", "items", 和 "none"。
+- `texture` (string): 物品的纹理。
+- `options` (Object): 可选参数配置对象。默认为空对象。
+  - `group` (string): 分组名称。
+  - `hide_in_command` (boolean): 是否在命令中隐藏物品。默认为 `false`。
+  - `max_stack_size` (number): 物品的最大堆叠数量。默认为 `64`。
+
+#### 抛出异常
+- 当 `identifier`, `category`, 或 `texture` 参数缺失或不是字符串时，抛出 `Error`。
+
+### 方法
+
+### `addComponent(componentMap)`
+向物品添加新的组件。
+
+##### 参数
+- `componentMap` (Map): 组件的 Map 对象。
+
+##### 抛出异常
+- 当 `componentMap` 参数缺失或不是 Map 实例时，抛出 `Error`。
+
+### `removeComponent(key)`
+从物品中移除一个组件。
+
+##### 参数
+- `key` (string): 组件的名称。
+
+##### 抛出异常
+- 当 `key` 参数缺失或不是字符串时，抛出 `Error`。
+
+### `toJson()`
+将物品转换为 JSON 格式，以便在游戏中定义物品。
+
+##### 返回值
+- `Object`: JSON 格式的物品对象。
+
+##### 内部实现
+根据物品的属性和组件，创建一个 `AddonItem` 实例，并返回其 JSON 表示。这个 JSON 对象可以被游戏引擎解析，用于定义游戏中的物品。
+
+---
+
+## ItemAPI 工厂函数
+
+`ItemAPI` 是一个用于创建和管理游戏物品的工厂函数集合，提供了多种方法来创建不同类型的物品。
+
+### `createItem(identifier, category, texture, options = {})`
+创建一个普通物品。
+
+#### 参数
+- `identifier` (string): 物品的唯一标识符。
+- `category` (string): 物品在创造菜单中的分类，可选值包括："construction", "nature", "equipment", "items"。
+- `texture` (string): 物品的纹理。
+- `options` (Object): 额外选项配置对象。默认为空对象。
+  - `group` (string): 物品的分组。
+  - `hide_in_command` (boolean): 是否在命令中隐藏物品。默认为 `false`。
+
+#### 抛出异常
+- 当 `identifier`, `category`, 或 `texture` 参数缺失或为空时，抛出 `Error`。
+
+#### 返回值
+- `Item`: 创建的普通物品对象。
+
+### `createFood(identifier, category, texture, options = {})`
+创建一个食物物品。
+
+#### 参数
+- `identifier` (string): 食物的唯一标识符。
+- `category` (string): 食物在创造菜单中的分类。
+- `texture` (string): 食物的纹理。
+- `options` (Object): 额外选项配置对象。默认为空对象。
+  - `group` (string): 食物的分组。
+  - `hide_in_command` (boolean): 是否在命令中隐藏食物。默认为 `false`。
+  - `animation` (string): 食用时的动画。默认为 `"eat"`。
+  - `canAlwaysEat` (boolean): 是否总是可以食用。默认为 `false`。
+  - `nutrition` (number): 食物的营养价值。默认为 `0`。
+  - `saturationModifier` (number): 饱和度修正值。默认为 `1`。
+
+#### 抛出异常
+- 当 `identifier`, `category`, 或 `texture` 参数缺失或为空时，抛出 `Error`。
+
+#### 返回值
+- `Food`: 创建的食物物品对象。
+
+### `createAttachable(identifier, texture, material, options = {})`
+创建一个可附着物品。
+
+#### 参数
+- `identifier` (string): 可附着物品的唯一标识符。
+- `texture` (string): 可附着物品的纹理。
+- `material` (string): 可附着物品的材质。
+- `options` (Object): 额外选项配置对象。默认为空对象。
+
+#### 抛出异常
+- 当 `identifier`, `texture`, 或 `material` 参数缺失或为空时，抛出 `Error`。
+
+#### 返回值
+- `Attachable`: 创建的可附着物品对象。
+
+### `createChestplateArmor(identifier, item_texture, texture_path, options = {})`
+创建一个胸甲护甲物品。
+
+#### 参数
+- `identifier` (string): 胸甲的唯一标识符。
+- `item_texture` (string): 胸甲的纹理。
+- `texture_path` (string): 胸甲的纹理路径。
+- `options` (Object): 额外选项配置对象。默认为空对象。
+
+#### 返回值
+- `Chestplate`: 创建的胸甲护甲物品对象。
+
+---
+
+## 内部实现
+- `ItemAPI` 使用 `GRegistry` 来注册物品和可附着物品的行为和资源路径。
+- 每个方法在创建物品后，会调用 `registerItem` 函数将物品注册到全局注册表中，以便游戏引擎能够识别和加载这些物品。

package/examples/digitCircuit/build.config

@@ -0,0 +1,28 @@
+{
+  "defaultConfig": {
+    "buildEntry": "main.mjs",
+    "scriptEntry": "scripts/index.js",
+    "buildDir": "dev/",
+    "dependencies": [
+      {
+        "module_name": "@minecraft/server",
+        "version": "1.8.0"
+      }
+    ]
+  },
+  "libraries": [
+    {
+      "path": "lib/"
+    }
+  ],
+  "resources": [
+    {
+      "path": "res/"
+    }
+  ],
+  "scripts": [
+    {
+      "path": "scripts/"
+    }
+  ]
+}

package/examples/digitCircuit/dev/digitCircuit_BP/blocks/sapdon_and_gate.json

@@ -0,0 +1,152 @@
+{
+  "format_version": "1.21.50",
+  "minecraft:block": {
+    "description": {
+      "identifier": "sapdon:and_gate",
+      "traits": {
+        "minecraft:placement_direction": {
+          "enabled_states": [
+            "minecraft:cardinal_direction"
+          ],
+          "y_rotation_offset": 180
+        }
+      },
+      "states": {},
+      "menu_category": {
+        "category": "construction",
+        "is_hidden_in_commands": false
+      }
+    },
+    "components": {},
+    "permutations": [
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'north'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              0,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'south'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'east'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              180,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'west'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              -90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      }
+    ]
+  }
+}

package/examples/digitCircuit/dev/digitCircuit_BP/blocks/sapdon_not_gate.json

@@ -0,0 +1,152 @@
+{
+  "format_version": "1.21.50",
+  "minecraft:block": {
+    "description": {
+      "identifier": "sapdon:not_gate",
+      "traits": {
+        "minecraft:placement_direction": {
+          "enabled_states": [
+            "minecraft:cardinal_direction"
+          ],
+          "y_rotation_offset": 180
+        }
+      },
+      "states": {},
+      "menu_category": {
+        "category": "construction",
+        "is_hidden_in_commands": false
+      }
+    },
+    "components": {},
+    "permutations": [
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'north'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              0,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'south'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'east'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              180,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'west'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              -90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      }
+    ]
+  }
+}

package/examples/digitCircuit/dev/digitCircuit_BP/blocks/sapdon_or_gate.json

@@ -0,0 +1,152 @@
+{
+  "format_version": "1.21.50",
+  "minecraft:block": {
+    "description": {
+      "identifier": "sapdon:or_gate",
+      "traits": {
+        "minecraft:placement_direction": {
+          "enabled_states": [
+            "minecraft:cardinal_direction"
+          ],
+          "y_rotation_offset": 180
+        }
+      },
+      "states": {},
+      "menu_category": {
+        "category": "construction",
+        "is_hidden_in_commands": false
+      }
+    },
+    "components": {},
+    "permutations": [
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'north'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              0,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'south'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'east'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              180,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      },
+      {
+        "condition": "q.block_state('minecraft:cardinal_direction') == 'west'",
+        "components": {
+          "minecraft:transformation": {
+            "translation": [
+              0,
+              0,
+              0
+            ],
+            "scale": [
+              1,
+              1,
+              1
+            ],
+            "scale_pivot": [
+              0,
+              0,
+              0
+            ],
+            "rotation": [
+              0,
+              -90,
+              0
+            ],
+            "rotation_pivot": [
+              0,
+              0,
+              0
+            ]
+          }
+        }
+      }
+    ]
+  }
+}