ms/MCBBS.MD at 8e94683757f726372ee8d1498f52ba0a7e9f7882

MiaoWoo 81c76f4977 feat: add example plugins

Signed-off-by: MiaoWoo <admin@yumc.pw>

2019-09-22 23:31:52 +08:00

11 KiB

Raw Blame History

为了方便阅读我对帖子进行了分页请点击目录阅读!

插件简介

此插件可以实现跨端使用 TypeScript 开发脚本插件
目前已经兼容 Spigot Sponge
后续计划兼容 BungeeCord Nukkit

起源 (可以略过)

简介

这个坑是我自己刨的但是发现坑太大需要更多的人一起填

起源

诞生于 2016年08月25日 这是 Git 上的第一个提交具体啥时候我也忘了
起初 MiaoScript 只是用于服务器其他插件的变量执行并且依赖于PAPI(不知道是啥的自己百度)
- 比如 MiaoMenu 的部分复杂脚本
- 比如 MiaoChat 的聊天变量
突然有一天圈内的大佬 QSB @qiu1995 过来找我说能不能用脚本监听玩家的事件
- PS: 这货自从用过 DeluxeMenu 之后就喜欢上了用JS写菜单
当初感觉没啥问题就出了第一个简易的 MiaoScript 版本还是用 yml 做的配置文件
但是由于设计 BukkitAPI 等内容对Java要求太高后来邱也弃坑了我也弃坑了

刨坑

时隔多年(也就一年) 看到了Sponge的兴起 (估摸着是MCPC系列的MOD端都弃坑了)
同时这期间收到很多腐竹的单子但是又是非常基础的东西
- 比如开服给玩家发一条消息啦
- 比如修改玩家某些数据啦
这些东西实际上也就几行代码的事情
同时很多想入坑插件开发但是又有一些被卡死在环境搭建上
- 比如 Bukkit 需要 BukkitAPI
- Sponge 需要 SpongeAPI 如果涉及 MOD 还要 Forge 环境
- 再或者 BungeeCord 的插件开发我也是经常懒得搞
当然最主要的是某个咕咕咕的群天天有人问我喵系插件能不能支持 Sponge
- 内心当然是拒绝的现在要上班养老婆孩子(咳咳不要以为我是大叔我也才刚毕业而已) 那里还有时间免费给你们写插件
于是乎我又想起了当初的 MiaoScript
突发奇想一个插件的雏形出现在我的脑海中
- 可以兼容多种服务器
- 不需要开发环境有记事本就可以开发
- 语法要简单比如 JavaScript
- 能够自动搜索安装依赖(毕竟很多人天天问我为何喵系插件跑不起来都是缺少PAPI)
- 能够不重启更新插件(当然得保证代码安全的前提下)
在 2017年9月14号(距离第一个版本正式版发布(2016-09-21) 相差一年整)
一个全新的 MiaoScript 诞生了
- Java部分代码只有一个启动类
- 核心全部由 JS 编写
- 兼容 CommonJS 规范
- 实时重载

进展

规划

初期只会支持JS类型的插件开发
二期会出一个建议版本的MS脚本可以用简单的语法实现简单的功能
各个层级会有依赖控制比如 MS脚本 => JS脚本 => 调用Java原生API

框架设计

MiaoScript TS 实现

项目具体实现由 TypeScript 进行编写然后编译至 es5 用于兼容 Java8 的 Nashorn

Project Structure

└─packages
    ├─api         全平台兼容的接口
    ├─core        核心代码 用于引导加载
    ├─common      公共类库代码 例如 http reflect 模块
    ├─container   IOC容器 用于注入具体实现
    ├─nashorn     Nashorn 的类型定义
    ├─bukkit      BukkitAPI内部实现
    ├─sponge      SpongeAPI内部实现
    ├─plugin      插件管理器
    └─plugins     这里当然是插件啦
        ├─bukkit  只兼容Bukkit的插件
        └─sponge  只兼容Sponge的插件

详细的内容就不逼逼了自己看代码吧

Github: https://github.com/circlecloud/ms

插件开发基础

开发IDE (推荐VSCode或者MiaoScrit在线IDE)

如果只是简单的开发你可用记事本 (但是没有任何补全和错误提示)

开发环境准备(针对高级用户))

安装 NodeJS 和 Yarn
拉取代码
- git clone https://github.com/circlecloud/ms.git
进入目录 ms
安装 npm 包
- yarn
编译一次生成对应的类库
- yarn build

直接在 MiaoScript Online WebIDE 开发

填坑中...

基本插件框架

HelloWorld 示例插件

先来一个 HelloWorld.ts 插件示范!

import { plugin, interfaces, cmd, listener, tab } from '@ms/plugin'

@plugin({ name: 'HelloWorld', version: '1.0.0', author: 'MiaoWoo', source: __filename })
export class HelloWorld extends interfaces.Plugin {
    load() {
        this.logger.log('Test Plugin load from MiaoScript Plugin System...');
    }
    enable() {
        this.logger.log('Test Plugin enable from MiaoScript Plugin System...');
    }
    disable() {
        this.logger.log('Test Plugin disable from MiaoScript Plugin System...');
    }

    bukkitload() {
        this.logger.log('Load When ServerType is Bukkit!')
    }
    bukkitenable() {
        this.logger.log('Enable When ServerType is Bukkit!')
    }
    bukkitdisable() {
        this.logger.log('Disable When ServerType is Bukkit!')
    }

    spongeload() {
        this.logger.log('Load When ServerType is Sponge!')
    }
    spongeenable() {
        this.logger.log('Enable When ServerType is Sponge!')
    }
    spongedisable() {
        this.logger.log('Disable When ServerType is Sponge!')
    }

    @cmd()
    hello(sender: any, command: string, args: string[]) {
        this.logger.log(sender, command, args);
        this.logger.sender(sender, JSON.stringify({ command, args }));
    }

    @tab()
    tabhello(_sender: any, _command: string, _args: string[]) {
        return ['world']
    }

    @listener({ servertype: 'bukkit' })
    playerjoin(event: any) {
        this.logger.console(`§aBukkit PlayerJoinEvent: §b${event.player.name}`)
        setTimeout(() => this.logger.sender(event.player, `§a欢迎来到 §bMiaoScript §a的世界!`), 10);
    }

    @listener({ servertype: 'sponge' })
    clientconnectionevent$join(event: any) {
        this.logger.console(`§aSponge ClientConnectionEvent.Join: §b${event.targetEntity.name}`)
        setTimeout(() => this.logger.sender(event.targetEntity, `§a欢迎来到 §bMiaoScript §a的世界!`), 10);
    }
}

进入 ms目录
执行编译 yarn build:plugins
从 packages/plugins/dist 中复制 HelloWorld.js 文件到对应的插件目录
- Bukkit: plugins/MiaoScript/plugins/
- Sponge: config/miaoscript/plugins/
重载 MiaoScript
打开客户端进入游戏预览一下效果
从 Spigot 服务端进入
从 Sponge 服务端进入

注册插件

从上面的示例可以看到一个插件通过注解 @plugin 即可启动
此注解接受一个 PluginMetadata 对象定义如下

export interface PluginMetadata {
    /**
        * 插件名称
        */
    name: string;
    /**
        * 前缀
        */
    prefix?: string;
    /**
        * 插件版本
        */
    version: string;
    /**
        * 插件版本
        */
    author: string | string[];
    /**
        * 插件源文件 必须指定为 __filename
        */
    source: string;
    /**
        * 插件本体
        */
    target?: any;
}

插件生命周期

MiaoScript的生命周期遵循了 Bukkit 的生命周期

MiaoScript针对不同的服务端提供了扩展的周期以服务端类型开头阶段名结束例如 bukkitload spongeenbale 扩展的生命周期只会在特定的服务器执行

load 加载阶段

此阶段通常用于初始化基础配置数据库链接等某些对外提供功能的插件需要在此阶段初始化完成

enable 启动阶段

此阶段通常用于注册命令注册事件等由于命令和事件 MiaoScript 已经托管了所以开发者可以直接用注解实现

disable 关闭阶段

此阶段通常用于注销命令注销事件等由于命令和事件 MiaoScript 已经托管了所以开发者可以直接用注解实现

注册命令/补全

cmd 命令

命令就是玩家在Minecraft中执行命令下面是一个示例的命令

命令是一个 function 通过 @cmd 注解注册
命令注册时默认使用方法名称为命令名称当前你可以传入 name 参数指定命令名称例如 {name: 'test'}
接受三个参数 sender: any, command: string, args: string[]
分别代表命令发送者命令名称命令参数

@cmd()
hello(sender: any, command: string, args: string[]) {
    this.logger.log(sender, command, args);
    this.logger.sender(sender, JSON.stringify({ command, args }));
}

tab 补全

补全就是玩家在Minecraft执行命令时使用 Tab键补全

补全是一个 functio 一般以 tab 开头需要补全的命令结尾通过 @tab 注解注册
补全注册时默认使用方法名称为补全名称当前你可以传入 name 参数指定命令名称例如 {name: 'test'}
接受三个参数 sender: any, command: string, args: string[]
分别代表命令发送者命令名称命令参数

注意: 当补全命令未注册时补全无效! 且补全和命令必须在同一个Class内!

@tab()
tabhello(_sender: any, _command: string, _args: string[]) {
    return ['world']
}

监听事件

事件是指 Minecraft 中发生的各种事情

监听事件是一个 function 通过 @listener 注册
事件名称默认为方法名称
- 所有类型服务端的事件 MiaoScript 都会进行一次映射方便使用
- 例如 PlayerJoinEvent 会映射为 PlayerJoinEvent, playerjoinevent, playerjoin 等
- 一般规则就是类名直接小写如果遇到子类则保留 $
- 例如 ClientConnectionEvent.Join 会映射为 clientconnectionevent$join
事件的注可以传入 servertype 来指定这个事件类型的服务端加载默认是所有服务端都加载
事件监听方法的第一个参数就是本次事件的具体内容 (这里就需要自己去查询对应的JavaDoc了)

@listener({ servertype: 'bukkit' })
playerjoin(event: any) {
    this.logger.console(`§aBukkit PlayerJoinEvent: §b${event.player.name}`)
    setTimeout(() => this.logger.sender(event.player, `§a欢迎来到 §bMiaoScript §a的世界!`), 10);
}

@listener({ servertype: 'sponge' })
clientconnectionevent$join(event: any) {
    this.logger.console(`§aSponge ClientConnectionEvent.Join: §b${event.targetEntity.name}`)
    setTimeout(() => this.logger.sender(event.targetEntity, `§a欢迎来到 §bMiaoScript §a的世界!`), 10);
}

插件列表

暂无

注意: 一楼的列表是老版本的新版本无法加载!

11 KiB Raw Blame History