Catalog

插件

· 作者 VulpineDev

Paper 服务器的 Modrinth 原生插件管理器。

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

最新 0.12.1+paper · 26.3 · Folia / Paper

一键开服(送7天)

适用于 Paper 1.18.2 及以上版本 需要 Java 17 及以上版本

Catalog 会在服务器启动时分析你的 plugins 文件夹,确定每个 .jar 文件对应的 Modrinth 插件。每个 jar 都通过其哈希值进行识别,因此即使文件被重命名也能被正确识别,无需手动映射。之后,你将在聊天窗口中收到更新通知,并能通过点击搜索、安装和移除插件。Catalog 无法识别的插件将保持原样不受影响。

要求

Paper 1.18.2 及更高版本(包括 Purpur 和 Folia)。Java 17 及更高版本。如果缺少任一条件,Catalog 将在启动期间自动禁用自身,并在控制台中打印原因。

插件必须发布在 Modrinth 上才能被管理。自定义 jar 文件和来自其他市场的插件仍可正常使用,Catalog 仅会忽略它们。如果你安装的插件已发布在 Modrinth 上,它就会被识别。

设置

从 Modrinth 下载 jar 文件并将其放入你的 plugins 文件夹。首次启动时,Catalog 会扫描你已有的插件并与 Modrinth 进行匹配。/catalog list 将显示所有已识别的插件及其更新信息。

安装

无需退出游戏即可在 Modrinth 中进行搜索。使用 /catalog search <query> 命令可查找适用于你服务器的插件,点击搜索结果即可打开其页面,查看描述、作者、下载量以及运行所需的依赖项。

安装同样只需一键完成。将 .jar 文件放入你的 plugins 文件夹后,插件将在下次重启时自动生效。如果某个构建版本需要你所缺失的插件,Catalog 会明确指出该插件,并提供一键安装选项。

仅提供与你的 Minecraft 版本完全匹配的构建。Purpur 和 Folia 的构建会与普通的 Paper 构建区分开来,因此如果一个插件同时提供 Paper 和 Purpur 的构建,Purpur 构建将安装在 Purpur 服务器上。

/catalog install <插件> <版本> 可将插件安装到任意你指定的构建版本中。

更新

Catalog 会在服务器启动时检查更新,并在之后每三小时自动检查一次。/catalog list 命令可显示哪些插件已过时,而 /catalog update <插件> 或 /catalog update all 则用于获取最新的构建版本。

在插件运行期间,不会进行任何替换。Catalog 会下载新的构建版本并交给服务器,服务器会在下次重启时、插件加载之前自动安装它。执行 /catalog cancel <plugin> 可以移除已下载的更新。

Catalog 可以自动处理你信任的插件的更新。一旦为某个插件启用了自动更新,它就会保持最新状态。Catalog 会在构建版本发布后等待数小时才进行安装。如果作者在等待期间发现问题并发布修复版本,你将直接安装修复后的版本,而不会安装有问题的旧版本。延迟时间、插件遵循的渠道以及自动更新开关都是针对每个插件单独设置的,因此你可以选择哪些插件需要立即更新,哪些可以稍后再更新。如果某个更新引入了新的依赖项,则在你安装缺失的依赖项之前,该版本的自动更新不会生效。

拥有 catalog.notify 权限的管理员在加入服务器时会收到一份摘要,内容包括:未启用的更新、上次重启应用了哪些更新、未能应用的更新、哪些自动更新失败及其原因,以及当前正在等待的内容。在配置文件中设置 notify_on_join: false 可以关闭此功能。

每个下载的文件在添加到你的插件文件夹之前都会经过验证:系统会检查文件是否正确、大小是否符合预期,并且确认该文件适用于你服务器上可用的 Java 版本。任何无法通过这些检查的文件都将被删除,而不是放入你的插件文件夹中。

Modrinth 上缺少哈希值或文件名不安全的文件将被拒绝。

损坏的构建版本

重启后,Catalog 会检查它所安装或更新的每个插件是否已启用。未加载或在启动时被禁用的插件会在加入服务器的摘要中进行报告。此时,你也可以点击按钮来回滚更新,同时会自动关闭该插件的自动更新功能,以防止再次安装损坏的构建版本。系统不会自动回滚任何内容。

卸载

被卸载的插件会被移动到一个单独的“回收站”文件夹中,而不是直接删除。移除某个插件后,你可以撤销该操作;执行 /catalog trash 可以列出所有已被移除的内容,以便你将其中的任何一个恢复回来。如果某个插件是其他插件的依赖项,则在移除它会先征求你的同意。这些被移除的文件将在 30 天后被永久删除,你可以在配置文件中修改这一期限或直接关闭此功能。

历史记录

执行 /catalog history 可以查看 Catalog 对你的服务器所做的所有操作:每次安装、更新、移除和恢复记录,包括发生的时间以及是谁发起的请求。

它还会记录出错的原因及情况:例如被阻止或失败的自动更新、重启后未能应用的已下载更新,以及在重启前被手动移除的已下载更新。执行 /catalog history --event failed 仅显示那些失败的记录。

命令

所有内容均可点击,因此你几乎无需输入任何命令。/catalog help 可列出所有可用命令。该命令同样支持 /ctlg、/cata、/ctl 和 /clg。

命令 说明 权限节点
/catalog 版本信息与致谢 catalog.command.about
/catalog help 所有命令 catalog.command.help
/catalog list [--updates] [--restart] [--held] [--untracked] 列出 Catalog 管理的所有插件,以及需要更新的插件 catalog.command.list
/catalog info <plugin> 获取任意插件的完整信息,无论是否已安装 catalog.command.info
/catalog search <query> 在 Modrinth 上搜索与你的服务器兼容的插件 catalog.command.search
/catalog versions <plugin> 查看最新的正式版、测试版和预发布版 catalog.command.info
/catalog dependencies <plugin> [version] 查看插件声明的依赖项,可选指定某个构建版本 catalog.command.info
/catalog history [--plugin <plugin>] [--author <name>] [--event <kind>] 查看 Catalog 的操作历史及操作者 catalog.command.list
/catalog install <slug> [version] 安装一个插件,可选指定某个构建版本 catalog.command.install
/catalog update <plugin|all> 下载更新,并在下次重启时应用 catalog.command.update
/catalog cancel <plugin> 取消已下载的更新 catalog.command.update
/catalog uninstall <plugin> 将插件移至回收站 catalog.command.uninstall
/catalog untrack <plugin> 停止管理该插件(不会删除 jar 文件) catalog.command.untrack
/catalog track <jar> 重新管理之前未跟踪的插件 catalog.command.untrack
/catalog trash 查看已移除的插件列表 catalog.command.trash
/catalog trash restore <plugin> 恢复已移除的插件 catalog.command.trash
/catalog trash delete <plugin|all> 永久删除已移除的插件 catalog.command.trash
/catalog settings <plugin> 设置频道、启用自动更新、设置暂挂状态 catalog.command.settings
/catalog reload 重载配置文件 catalog.command.reload

设置界面可以通过点击来配置以下选项,但这些选项同样可以作为命令使用,这也是你在控制台中需要用到的方式。

命令 说明 权限节点
/catalog channel <plugin> <channel> 选择跟随正式版、测试版或预发布版 catalog.command.channel
/catalog auto <plugin> <on|off> 自动更新此插件 catalog.command.settings
/catalog soak <plugin> <window> 自动更新前的等待时间,例如 30m、2h 或 default catalog.command.settings
/catalog hold <plugin> 保留当前版本并停止提供更新 catalog.command.hold
/catalog unhold <plugin> 允许再次更新 catalog.command.hold

权限

权限节点已在上方每个动作/命令旁列出。

节点 说明
catalog.admin 所有权限
catalog.* 所有权限
catalog.command.<name> 单个命令/动作
catalog.notify 加入服务器时显示更新摘要

配置

plugins/Catalog/config.yml 文件简短且带有注释。大多数用户会修改应用于新跟踪插件的默认设置,包括其发布频道、是否自动更新、自动更新前的等待时间,以及检查更新的频率和回收站保留移除记录的时间。Modrinth Token 是可选的:它可以提高请求限制,并允许读取私有项目。

常见问题

它会重载或热交换插件吗? 不会。Catalog 在服务器运行时不会触碰插件,这样可以防止类加载器泄漏和文件锁定问题。构建包会被下载,并在插件加载之前的下一次重启时由服务器应用。

那些不在 Modrinth 上的插件怎么办? 它们会被忽略。Catalog 不会对它们执行任何操作。

它能否安装我的服务器无法运行的插件? 只有在配置中开启 allow_incompatible_installs 时才可能。否则,构建包会根据你的 Minecraft 版本和服务器平台进行过滤,并且每次下载都会针对你服务器运行的 Java 版本进行检查。

它会“电话回家”吗? 它会与 Modrinth API 通信,并向 bStats 报告匿名服务器统计数据,你可以在 bStats 配置中关闭此项。

由 Vulpine 制作

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源