CogWorks

插件

· 作者 Mapty231

一款适用于 Spigot Minecraft 的插件,让你能够通过聊天轻松安装和删除插件,并借助内置文件管理器编辑其配置文件!

0 本站下载 0 关注 更新于 3 年前

最新 0.3.1 · 1.20.2 · Bukkit / Paper

一键开服(送7天)

CogWorks:

允许直接从 Minecraft 中轻松、无缝地管理插件和文件!

重要提示:

只有位于服务器 jar 包同级文件夹及其子文件夹中的文件和文件夹,才能通过此插件访问!
或者更技术性地来说,该插件只能访问绝对路径以服务器文件夹绝对路径开头的文件或文件夹。

此外,CogWorks 仍处于 alpha 阶段,因此会存在错误。如果您发现任何错误,请在 Discord 的 #bug-reports 频道中报告。我们会倾听并非常感谢任何反馈。

一般信息:

不兼容性:

如果安装了修改聊天消息的插件,在与 CogWorks 聊天消息交互时可能会出现消息被取消的问题。
例如,任何“无图表报告”类插件都可能引发此类问题。
如果您是这些插件的作者之一,或者有任何解决此问题的想法,请通过 Discord 联系 tye。

下载:

最新的公共版本插件始终可在 Modrinth 和 GitHub 上获取。或者您可以加入 Discord,查看是否有可供测试的快照构建版本!

命令:

  • /plugin help - §a 显示帮助消息。

  • /plugin install <URL> - 从 URL 下载文件到 ./plugins 文件夹。

  • /plugin search <Plugin name> - 使用 Modrinth 搜索给定的名称并返回结果,可选择其中一个进行下载。

  • /plugin browse - 允许用户浏览与您服务器类型兼容的最流行插件,并通过点击按钮安装它们。

  • /plugin reload - 强制 CogWorks 重新扫描 ./plugins 文件夹。

  • /plugin remove <Plugin name> - 禁用并卸载指定的插件。

  • /file help - 显示此消息。

  • /file chat - (开发中)将您的聊天转换为模拟命令行,让您与服务器上的文件进行交互。

  • /file gui - 打开一个库存界面,让您以可视化方式与服务器上的文件进行交互。

  • /file recover <Deleted file> <Restore path> - 将已删除的文件恢复到指定路径;如果未提供路径,则文件将恢复至服务器文件夹。

功能:

  • 使用 "/plugin install <URL>" 从网络安装 jar 文件

  • 通过 "/plugin browse" 或 "/plugin search <query>" 从 Modrinth 安装插件

  • 从 Modrinth 下载插件时,会自动安装其依赖

  • 如果 CogWorks 在启动时检测到未满足的依赖项,将尝试自动安装。如果您网络速度较慢或带宽有限,请在配置文件中禁用此功能。

  • 使用 /plugin remove <插件名称> 命令删除插件。

  • 在删除插件时,会弹出提示询问是否同时删除该插件的配置文件文件夹,以及是否删除依赖此插件才能正常运行的其他插件。

  • 通过输入 "/file" 访问图形化文件浏览器。

  • 独特的插件交互方式:只需在聊天栏中直接回复即可,无需使用命令!

  • 支持权限系统。

  • 支持 "/reload" 命令。

权限:

  • cogworks.plugin.ins.gen - 允许使用 "/plugin install <URL>" 命令从任意 URL 安装插件。

  • cogworks.plugin.ins.modrinth - 允许使用 "/plugin search <query>" 和 "/plugin browse" 命令从 Modrinth 安装插件。

  • cogworks.plugin.reload - 允许使用 "/plugin reload" 命令,使 CogWorks “重新扫描” ./plugins 文件夹以检测任何更改。

  • cogworks.plugin.rm - 允许使用 "/plugin remove <插件名称>" 命令来移除插件及其配置文件夹。

  • cogworks.file.nav - 可以使用 /file 命令查看文件与文件夹,并在文件夹间进行导航。

  • cogworks.file.read - 在使用 /file 命令时能够读取文件内容。

  • cogworks.file.edit - 在使用 /file 命令时能够编辑文件内容。

  • cogworks.file.mk - 在使用 /file 命令时能够创建新文件。

  • cogworks.file.rm - 在使用 /file 命令时能够删除文件。

  • cogworks.file.rec - 能够使用 /file recover 命令恢复已删除的文件。

配置帮助:

Lang:
此值将决定 CogWorks 使用哪个语言文件。
如果你想帮助 CogWorks 支持另一种语言,请参阅 寻找翻译人员!。

要了解你可以使用的值,你可以按照配置文件中的链接操作。
或者点击 这个链接,选择与你正在使用的 CogWorks 版本相对应的文件夹,文件名即为可用的值。记得在输入文件名时不要包含 ".yml" 后缀。

ShowErrorTrace:
这决定了当发生错误时,CogWorks 是否会在控制台中显示错误信息。
在 CogWorks 脱离 Alpha 和 Beta 阶段之前,此项默认启用。
如果你要向 CogWorks 提交 Bug 报告,你需要在提交报告时保持此选项处于启用状态。

设置为“true”以启用此功能,或设置为“false”以禁用此功能。
请注意,这仅适用于代码中已处理的错误。如果错误未被处理,则无论怎样都会将堆栈跟踪发送到控制台。

ShowOpErrorSummary:
当拥有 OP 权限的玩家加入时,会向他们发送自上次重新加载/重启以来该插件发生的严重错误数量。

设置为 "true" 以启用此功能,或设置为 "false" 以禁用此功能。

ADR:
如果某个插件在服务器启动时缺少依赖项,CogWorks 将尝试通过从 Modrinth 下载来自动解决该依赖项。如果在 Modrinth 上找不到匹配项,则不会再尝试。

设置为 "true" 以启用此功能,或设置为 "false" 以禁用此功能。
如果你使用的是慢速连接或带宽有限,建议禁用此功能。

KeepDeleted:
Time:
删除的文件在最终被清除前应保留多久。

该值应使用以下格式:{number}w 表示周,{number}d 表示天,{number}h 表示小时,{number}m 表示分钟。
示例:"1d3h"
这将使文件最多保留一天零三小时。

如果您不希望基于时间删除文件,请将其设置为 "-1"。

Size:
恢复文件夹允许的最大大小。如果超过此值,则最旧的文件将被删除,直到大小低于指定的限制。如果某个被删除的文件大于指定大小,它将立即被删除,且恢复文件夹中已存在的文件不受影响。

该值应以如下格式给出:{number}g 表示千兆字节(GB),{n}m 表示兆字节(MB),{n}k 表示千字节(KB)。
示例:"100m20k" 这将确保恢复文件夹的大小永远不会超过一百兆字节加二十千字节。

如果您不希望基于恢复文件夹的大小删除文件,请将其设置为 "-1"。

未来计划:

  • 支持从其他网站下载插件。
  • 基于聊天的文件管理器。
  • 在使用 URL 时允许一次性安装多个插件。
  • 修复在使用插件安装时,如果快速重复输入插件版本的选项数字,会导致插件被安装两次的问题(尽管最终只会显示一个文件)。
  • 如果服务器已更新,尝试为正确的服务器版本安装插件。
  • 在使用 /plugin browse 时,是否允许发送者传递偏移量?
  • 当 OP 加入时发送语言更新消息。
  • 允许用户退出/返回所有状态。
  • 是否要求确认语言更新才能消失?
  • 使用 "/file gui" GUI 时使用户处于无敌状态。
  • 对文件 GUI 标题设置字符限制,以防止溢出(例如从路径开头移除字符?)。
  • 对通过 URL 安装的插件运行 ADR。

进一步阅读:

本节将包含更多技术细节,供感兴趣或希望在不阅读代码的情况下获得介绍的读者参考。

关于聊天交互:

使用 CogWorks 时,您可能会很快注意到它具有处理玩家与命令交互的独特方式。
例如,在与 "/plugin search <query>" 交互时,CogWorks 会向用户发送多条消息,其中以 "number:" 开头的消息是可以选择的选项。要选择其中一个选项,只需在聊天中输入对应的数字即可,无需 "/" 或其他任何命令。CogWorks 会阻止该聊天消息发送给其他用户。
此外,在使用 "/plugins search <query>" 和 "/plugin browse" 时,带有下划线文本的消息将包含指向其所指内容的超链接。例如 "1: Simple Voice Chat",这将带您进入 Modrinth 上 Simple Voice Chat 插件的主页。这种情况也出现在插件有多个有效版本时,此时提供的链接将带您进入该特定版本的 Modrinth 页面。这些链接始终会将您带到与您想要选择的选项相关的详细信息页面。

关于 "/plugin install <URL>":

对于此命令,下载文件的扩展名将始终设置为 ".jar"。另外请注意,您需要获取实际文件下载的 URL,而不仅仅是您可以从中下载文件的网站 URL 或插件信息页面的 URL。
例如:
正确:
错误:
错误:
错误:

判断其是否为文件的一个简单方法是检查 URL 是否以 ".jar" 结尾。但是,请注意,并非所有插件下载链接都以 ".jar" 结尾!

关于 "/plugin search <Query>":

对于此命令,查询 可以 包含空格,并且仍被视为单个有效的搜索请求。此外,任何会导致无效 URL 的字符都会自动转换为 URL 使用的 百分号编码。

关于 "/plugin browse":

顾名思义,此命令将让您浏览 Modrinth 上与您的服务器类型和版本兼容的最热门插件。使用 "0" 和最大值作为选项来“滚动”浏览插件列表,输入 "0" 会在适用情况下向上滚动,反之亦然。

关于 "/plugin reload":

此命令会使 CogWorks “重新扫描” "./plugins" 文件夹,以查找那些非通过 CogWorks 进行的更改。

关于 "/plugin remove <Plugin name>":

此命令只有在删除队列中不再有剩余插件需要评估后才会执行删除操作(删除队列仅是一个需要用户输入有关删除选项的插件列表)。
该命令的工作方式是让您从 "./plugins" 文件夹中的任何插件中选择要移除的插件(包括未能成功加载的插件)。
如果您选择的插件拥有配置文件文件夹("./plugins/<plugin name>"),系统也会提示您是否删除该文件夹。
然后,如果有其他插件将以您即将删除的插件作为依赖项,系统将提示您是仅删除此插件、删除依赖于它的插件,还是退出。
对于选择删除依赖于该插件的其他插件的选项,这些插件将被添加到删除队列中,因此配置检查及依赖项检查将对您选择删除的所有插件执行。

关于 "/file" 或 "/file gui":

此命令将为玩家打开一个物品栏,允许他们导航那些路径以服务器文件夹所在路径开头的文件。
举个例子,假设服务器 jar 文件位于 "D:\paperSever"(这也适用于 Linux 系统,此处仅使用 Windows 文件路径作为示例)。文件 "D:\paperSever\server.properties" 和 "D:\paperSever\world\playerdata" 是用户可以访问的,因为它们的路径与服务器文件夹的路径开头相同。然而,文件 "D:/taxInformation" 和 "C:\Program Files" 无法被访问,因为它们的路径开头与服务器文件夹的路径不同。
所有文件都将用白色羊毛表示,物品描述为“File”;所有文件夹将用黄色羊毛表示,描述为“Folder”。请注意,物品描述文本可以在语言文件中更改。物品的名称对应相应的文件名。
当用户点击某个文件夹时,物品栏将更改以显示该文件夹的内容,文件同理。要返回上一级,只需点击箭头即可。
查看文件时,用户可以将鼠标悬停在纸张上以查看该行文本的片段。他们可以使用顶部的 tipped arrows 在文件中上下滚动。橡木告示牌将显示屏幕顶部行的行号。书和笔可以让用户在文件中搜索特定短语。至于输入搜索短语时出现的奇怪字符,不用担心,它只是为了让纸张不被命名为“paper”,它会被自动移除。使用幻翼之箭可以选择行号并立即跳转到该行。
要编辑文件内容,您必须先查看它。如果您想更改已写入的某些文本,只需点击带有该文本名称的物品,这将打开一个铁砧界面,让您将文本重命名为任何您想要的名称。要在空行或行尾添加文本,您可以点击同一行中的任何空槽位,铁砧菜单将再次打开,您输入的任何文本都将添加到该行中。要删除文本,请执行与编辑文本相同的操作,但在铁砧中将其全部删除。
点击绿色混凝土块将更改物品栏,允许您创建文件或文件夹。之后会打开一个铁砧菜单,允许您设置文件的名称。请勿输入文件名中不允许使用的字符!
要删除文件或文件夹,请点击红色混凝土块,这将使您进入“删除模式”。为了向用户清楚地表明这一点,文件将变为橙色羊毛,文件夹将变为红色羊毛。然后只需点击文件或文件夹以打开删除确认菜单,再点击绿色混凝土块即可删除文件或文件夹。如果您尝试删除包含文件或文件夹的文件夹,将会多出一个额外的确认步骤。

关于 "/file restore <Deleted file> <Restore path>"

当文件被删除时,它们将被存储在 "{severFolder}/plugins/.data/deletePending" 中,直到文件满足删除条件,或使用此命令恢复。
选定的文件将恢复到指定的路径。如果给定的路径是一个文件夹,则该文件将以原始名称放入该文件夹中。如果恢复路径以文件名结尾,则该文件将被重命名并移动到恢复路径。

关于自动依赖解析:

自动依赖解析(以下简称 ADR)涉及 CogWorks 在启动时检查任何缺失的依赖项,并通过获取缺失插件的名称(插件名称是在 plugin.yml 中指定的名称)并在 Modrinth 上搜索该名称来尝试解决它们。
然后它会下载 Modrinth 返回的前几个插件(到 "CogWorks/.temp/ADR/<UniqueDirName>"),并检查下载的插件中是否有任何插件名称与缺失依赖项的插件名称匹配。如果其中一个插件匹配,它将被移动到 "./plugins" 文件夹。剩余的插件将被删除。
如果 ADR 在无错误的情况下完成且依赖项仍未解决,则它将不再尝试解决该依赖项。

寻找翻译人员!

如果您愿意通过将插件语言文件翻译成任何新语言(针对过去版本或当前版本)来帮助我。请加入 discord server 并 @IWantToTranslate。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源