https://github.com/leoweyr/legacy-script-engine-scaffold
A utility for assisting in the development of Legacy Script Engine plugins, supporting a native development experience on the Node.js platform.
https://github.com/leoweyr/legacy-script-engine-scaffold
bedrock-dedicated-server cli levilamina minecraft nodejs npm npx scaffold utility
Last synced: 5 months ago
JSON representation
A utility for assisting in the development of Legacy Script Engine plugins, supporting a native development experience on the Node.js platform.
- Host: GitHub
- URL: https://github.com/leoweyr/legacy-script-engine-scaffold
- Owner: leoweyr
- License: mit
- Created: 2025-01-25T09:25:21.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2026-02-21T06:51:27.000Z (5 months ago)
- Last Synced: 2026-02-21T13:37:22.303Z (5 months ago)
- Topics: bedrock-dedicated-server, cli, levilamina, minecraft, nodejs, npm, npx, scaffold, utility
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/legacy-script-engine-scaffold
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-zh_cn.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Legacy Script Engine Scaffold
#### [English](README.md) | 简体中文
支持 Node.js 平台原生体验、辅助 Legacy Script Engine 插件开发的脚手架工具。
> 当前仅支持 TypeScript 项目
## 📦 准备工作
这是一个非侵入式工具，它不会在你的项目中保留任何强制性配置文件。建议将其添加为项目的开发依赖以方便在环境中使用：
```bash
npm install @levimc-lse/scaffold --save-dev
```
## 🚀 使用方法
### 生成 Legacy Script Engine 插件的 manifest.json 文件
```bash
npx lses manifest
```
### 打包 Legacy Script Engine 插件
```bash
npx lses pack
```
### 根据路径将 Legacy Script Engine 插件包部署到 LeviLamina 服务器
```bash
npx lses deploy-path [options]
```
| 必须参数 | 作用 | 类型 |
| ------------- | --------------------------------- | ------ |
| `` | 根据工作目录指定对应 LeviLamina 服务器 | 字符串 |
| 可选参数 | 作用 | 类型 | 默认值 |
| ------------------------------------- | ----------------------------- | ------- | ------- |
| `-h, --host ` | 指定远程 Windows OpenSSH 主机 | 字符串 | |
| `-P, --port ` | 指定远程 Windows OpenSSH 端口 | 整数 | 22 |
| `-u, --username ` | 指定远程 Windows OpenSSH 用户名 | 字符串 | |
| `-p, --password ` | 指定远程 Windows OpenSSH 密码 | 字符串 | |
### 启动 LeviLamina 服务器作为调试器
```bash
npx lses debug [options]
```
| 必须参数 | 作用 | 类型 |
| -------- |---------------------------| ------ |
| `` | 根据工作目录指定对应 LeviLamina 服务器 | 字符串 |
| `` | 指定 LeviLamina 服务器调试器实例的名称 | 字符串 |
| 可选参数 | 作用 | 类型 | 默认值 |
| ------------------------------------- | ----------------------------- | ------- | ------- |
| `-h, --host ` | 指定远程 Windows OpenSSH 主机 | 字符串 | |
| `-P, --port ` | 指定远程 Windows OpenSSH 端口 | 整数 | 22 |
| `-u, --username ` | 指定远程 Windows OpenSSH 用户名 | 字符串 | |
| `-p, --password ` | 指定远程 Windows OpenSSH 密码 | 字符串 | |
### 将 Legacy Script Engine 插件包部署到 LeviLamina 服务器调试器实例
> 💡 **关键特性**
>
> 相较于 `npx lses deploy-path`，这种方式在插件部署后会自动进行热重载。
```bash
npx lses deploy-debug
```
| 必须参数 | 作用 | 类型 |
|-------------------|---------------------------------| ------ |
| `` | 根据名称指定对应 LeviLamina 服务器调试器实例 | 字符串 |
## ❗ 重要提示
1. package.json 中的 `main` 入口文件路径配置应相对于项目的工作目录，而不是 Legacy Script Engine 已打包插件的目录。
例如，在 TypeScript 项目中，若源码已定义 index.ts 为程序入口，并在 tsconfig.json 中配置 TypeScript 编译器输出目录为 dist，则应该将 package.json 中的 `main` 入口文件路径配置设置为 `dist/index.js`。
这样确保通过 `npx lses manifest` 生成的 manifest.json 文件中的 `entry` 插件程序入口配置能够被 LeviLamina 正确识别和定位。
2. 在使用 `npx lses deploy-debug` 之前，确保对应的 LeviLamina 服务器调试器实例已开启，如果没有请先使用 `npx lses debug` 来启动它。