cbDocmand

插件

· 作者 _ForgeUser7442048

cbDocmand

0 本站下载 0 关注 更新于 9 年前
一键开服(送7天)

Docmand - 文档与命令

下载 v0.6.04
允许创建自定义命令,将文件或 URL 的内容发送给玩家。
支持自定义加入消息(MOTD)和传送提示。
内置标签系统,可将内容中的标签转换为 Java 代码,从而实现高度定制化。
你可以决定插件的具体行为(在插件功能允许的范围内)。
可视为功能极其丰富的 MCDocs 替代品。
支持权限系统和多世界。
支持参数传递,可将参数解析并传递给命令、别名及其他部分的各个组件。

更新说明

从 0.5x 版本更新至 v. 0.6.xx 前的重要提示:

请删除或重命名你的 events.yml 文件,系统将自动生成一个新的示例文件以适配新代码。
旧版 events 文件与新系统不兼容。请重新配置你的事件。
对于由此带来的不便深表歉意,但此次更新对事件系统进行了重大变更。我将在下一次更新中提供更完善的升级方案。
建议同时删除 default.yml 解析器配置文件,它将自动重新生成并包含一些新的解析器。此外,尽量避免向 default.yml 解析器文件中添加自定义解析器,而是将它们创建在单独的文件中。

安装

下载并将其放入 plugins 文件夹。重载服务器。
cbDocmand 将自动生成默认配置文件和一些示例文件。

配置

cacheTime所有文件和 URL 都会被加载到内存中并存储。此缓存时间指定在获取更新文本之前保留这些数据的时间长度(单位:秒)
linesPerPage创建分页时每页显示的行数。当显示的行数达到 linesPerPage + 1 时,将触发分页
logLevel(当前未使用)要显示的日志级别。0 = 无,1 = 少量信息,2 = 更多信息,3 = 所有调试信息
paginationHeader分页标题的渲染格式。可使用 3 个变量:%x 表示当前页码,%y 表示总页数,%commands 将渲染为使用 pageCommands 定义的 3 个分页导航命令
pageCommands定义用于浏览页面的命令。

用法

根据需要,在 files 文件夹中添加任意数量的文件。
根据需要,在 events.yml 文件中添加任意数量的事件。

你可以随意编辑并添加任意数量的解析器。建议不要修改默认解析器,因为随着新版本发布它会随之更新,但你可以添加新文件。所有位于 parsers 文件夹中的 .yml 文件都会被加载,因此你可以自由添加支持你常用插件的解析器,并在 论坛 上分享它们。

发送给玩家的消息会使用标准的 Minecraft 颜色进行着色,当使用 &x(其中 x 为十六进制 0-f)编写时。
如果消息超过 9 行(或在配置中指定的行数),发送给玩家的消息将自动转换为分页。
可以通过输入 next、previous 或 page 命令来查看页面,具体命令由 pageCommand 配置定义。
例如,执行 /rules 命令会向用户发送 16 行内容。内容会自动分为两页,并显示一个介绍分页的头部信息
第 1 页,共 2 页(输入 /next、/prev 或 /page <x> 选择页面)
用户可以随后发送 /next 或 /page 2 命令来查看第二页。

你可以使用以下命令重新加载所有配置文件:
/docmand reload - 需要权限 docmand.reload

Docmand 权限

docmand.reload允许重新加载所有 Docmand 配置、事件、文件和解析器。
docmand.all拥有此权限的用户将跳过所有事件(Events)的权限检查。

概念

使用 cbDocmand 需要了解三个概念:事件(Events)、解析器(Parsers)和文件(Files)。

事件(Events)

共有三种类型的事件:
Commands:当玩家输入指令时触发。
Joins:在玩家加入服务器时触发。
Teleports:当玩家通过指令、插件或下界传送门传送到指定世界时触发。

事件的定义是通过编写包含一个或多个事件描述的元素来实现的(顺序不限)。

你可以为同一个触发器指定多个事件,例如可以添加 1 个以上的加入(join)事件,或者根据权限和世界向命令添加更多事件等。
所有满足条件的事件都会被触发,因此如果某个事件未指定世界或权限,它将与已指定世界或权限的事件同时触发。
支持的事件描述包括:World(世界)、Permission(权限)和 Actions(动作)。

World(世界)事件描述:
你可以指定一个或多个该事件将触发的世界,
可以通过多个描述来指定,也可以以数组形式指定。
例如:
World: World
World: World_nether
或者
World: [World, World_nether]

Permission(权限)事件描述:

你可以指定一个或多个权限,事件触发时需要具备这些权限

如果有多个,则必须为玩家设置所有列出的权限才能触发

可以使用多个描述或数组来指定

可以设置为任意权限,因此你可以复用其他插件使用的权限,或者创建自己的权限等。
例如:
Permission: someplugin.somepermision
Permission: someotherplugin.someotherpermission
或
Permission: [someplugin.somepermision. someotherplugin.someotherpermission]

Actions 事件描述:
你可以指定多个触发动作。
动作基于键值对,其中键是动作类型,值是动作的内容。
动作在 Actions 事件描述中指定。
动作会按照指定的顺序触发。所有向用户渲染文本的动作
都会被合并在一起,形成一段文本,该文本随后会自动分页(分页处理)。
剩余的所有 Command 动作则会按出现顺序依次触发。
例如:
Actions:
- Text: 'Some text here'
- Command: /somecommand

支持的 4 种动作为:
Url:定义将内容发送给玩家的 URL
File:定义放置在插件 files 文件夹中的文件,将内容发送给玩家
Command:定义要触发的命令(注意:这会触发聊天行为,因此如果命令未加斜杠 /,玩家会将消息发送到服务器)
Text:发送给玩家的内容,与 file/url 相同,但无需外部文件

所有动作都可以包含解析脚本,写法为 %someparse%
解析脚本支持参数,例如 %someparse("World",4)%

对于加入和传送,事件描述以 Joins/Teleports 类别下的多个事件形式编写。
而 Commands 事件则需要分配一个命令。
这是通过写入命令名称来实现的,并在该命令下指定(一个或多个)事件描述。

命令支持参数(自变量)
例如:
help
help worldedit
help tp

在此示例中,如果用户输入 "help me",它将默认回退到 help 命令,插件会寻找最精确的匹配项。
但如果用户输入 "help tp",则只会触发为此命令指定的事件,而不会默认回退到 help 命令。

命令还支持参数解析。因此在命令之后指定的参数将作为 $n(其中 n 是参数编号)发送到内容中编写的任何解析器。
例如,如果用户输入:
/help worldedit hello rules.txt
插件将触发 help worldedit 命令,并将 hello 解析为参数 $1,将 rules 解析为参数 $2。
例如(针对 help worldedit 命令)
Actions:
- File: worldedit.txt
- Text: 'You wrote $1'
- Text: '%includeFile($2)%'

这将获取 worldedit.txt 的内容,然后输出 "You wrote hello",接着包含文件 "rules"。

示例

Joins:
  - World: Test
    Permission: docmand.test1
    Actions:
    - Text: 'Youhavepermissiontest1'
  - World: [Test, Test_nether]
    Permission: docmand.test2
    Actions:
    - Text: 'Youhavepermissiontest2'
  - Actions:
    - File: motd.txt
Commands:
    someurl:
    - Actions:
      - Url: 
    serverrules:
    - Actions:
      - Command: /rules
    news:
    - Actions:
      - File: news.txt
    motd:
    - Actions:
      - File: motd.txt
    rules:
    - Actions:
      - File: rules.txt
    test:
    - Actions:
      - Text: 'Somethingtest'
    test hello:
    - Actions:
      - Text: 'Somethingothertesthello'
    test say:
    - Actions:
      - Text: 'Yousaid:$1'
    me:
    - Actions:
      - Command: '/say&d%player_name%is$1'
    stuff:
      - Text: 'Some$1andfirstlinefrom$2:%lineFromCommand("$2",1)%'
    permworldtest:
    - World: World

权限: docmand.permworldtest1 操作: - 文本: '你拥有 permworldtest1 权限'

- 文本: 'Andareinworld%world_name%' - 权限: docmand.permworldtest2 世界: [World,World_nether] 操作:

- 文本: '你正在世界%world_name%中'

- 文本: '并且具有 permworldtest2 权限' - 操作: - 文本: '你拥有 test1 或 test2 权限'

权限: [docmand.test1,docmand.test2] - 世界: - World - World_nether 操作:

- 文本: 'Helloworld' 帮助:

- 权限: minecraft.tp 操作:

- 文本: '&b/helptp' - 权限: minecraft.give 操作: - 文本: '&b/helpgive' - 权限: minecraft.settime 操作: - 文本: '&b/helpsettime' help tp: - 权限: minecraft.tp 操作:

- 文本: 'Youwrite/tp<player1><player2>'
帮助 give: - 权限: minecraft.give 操作:

- 文本: '你编写/give<itemid><itemnum>它将给你你这些物品' 帮助 settime:

- 权限: minecraft.settime

操作:

- 文本: '你输入 /settime <xxx>,其中 xxx 是时间(以刻为单位)'

传送点: - 世界: World 权限: docmand.test1 操作: - 文本: 'WelcometoWorld' - 世界: World_nether 权限: docmand.test2 操作: - 文本: 'WelcometoHell!'

解析器

解析器由一个解析关键字和一些基本的 Java 代码组成(仅支持基本代码,且仅支持单行代码)
内置函数可以直接调用,同时您也可以访问 Player 对象和 Server 对象。
因此,若要创建一个返回玩家当前所在世界名称的解析器,您可以这样写:
player_world: Player.getWorld().getName()

这随后可以从任何 Text、Url 来源或 File 来源进行解析,例如:
Welcome to %player_world%

也支持参数。
lineFromCommand: readLineFromCommand($1,$2)
注意 $1 和 $2,它们是参数占位符。
您可以通过指定带有括号的参数来使用带参数的解析命令进行解析。
Latest news: %readLineFromCommand("news",1)
这将把 "news" 作为第一个参数,1 作为第二个参数进行解析。
此命令将读取指定为 /news 的命令的输出行,并仅返回第一行。

支持数组/列表:
Server.getPlayers[0].getName()
Server.getPlaysers.get(0).getName()
Server.getPlayers[$1].getName()

解析器也支持 void 方法,因此您可以执行以下操作:
添加事件

命令:
hurt:
Text: You were damaged 5 hearts %damage_player(5)%

添加解析器
damage_player: Player.damage($1)

现在您就拥有一个会显示消息 "You were damaged 5 hearts" 然后触发伤害效果的命令了。

内置函数(更多功能即将推出)

Java参数描述
readLineFromCommand($1,$2)命令, 行数包含从命令渲染的前 x 行数
readLinesFromCommand($1,$2,$3)指令,起始行,结束行包含从某指令渲染出的文本中,从起始行到结束行的所有行
getOnlinePlayerNames()返回在线玩家名称的逗号分隔列表
getPlayersInPlayerWorld()获取当前玩家所在世界中的在线玩家
includeFile($1)文件名从 files 文件夹中包含一个文件
includeCommand($1)指令名称包含某个指令的内容

示例

server_name: Server.getServerName()
player_name: Player.getName()
players_in_world: getPlayersInPlayerWorld()
online_players: getOnlinePlayerNames()
online_players_count: Server.getOnlinePlayers().length
lineFromCommand: readLineFromCommand($1,$2)
player_world: Player.getWorld().getName()
linesFromCommand: readLinesFromCommand($1,$2,$3)
include: includeFile($1)
includeCommand: includeCommand($1)

文件

通过 File 命令类型引用的文件,必须位于 cbDocmand/Files 文件夹中。

示例

Hi %player_name% and welcome to %server_name%
There are &d%online_players_count% &fplayers online
&aOnline: &c%online_players%
%include("include.txt")%

&a全部新闻:&b/news &a规则:&b/rules(或 /serverrules)

未来/想法/当前问题

  • 增加更多内置函数
  • 提供更多代码支持(如数学运算等)
  • 增加更多可在解析器中访问的基础类(目前仅支持 Player 和 Server)。
  • 清理代码,并将代码提交至仓库。
  • 增加更多默认解析器。
  • 是否支持 Spout?

不再属于未来,已实现/修复

  • 权限支持
  • 修复自动分页
  • 使用权限节点支持群组
  • 支持嵌套解析器(评估一个解析器,并将其传递给另一个解析器进行解析)
  • 事件中的多个操作
  • 分页命令

结语

希望你喜欢它。欢迎评论、提出想法或报告错误。也欢迎提供解析命令(已准备好供其他插件使用的 parse command 文件),我们将非常感激。
玩得开心!

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源