CogWorks

# CogWorks: 允许轻松无缝地管理插件和文件，直接在 Minecraft 中进行！ ## 重要提示： 只有位于服务器 jar 文件夹内，以及该文件夹内的子文件夹中的文件和文件夹，才能使用此插件访问！ 或者，用更技术性的术语来说，该插件只能访问其绝对路径以服务器文件夹的绝对路径开头的任何文件或文件夹。 此外，CogWorks 仍处于 alpha 阶段，因此可能会存在错误。 如果您发现任何错误，请在 [discord](https://discord.gg/3CC6kVcdQH) 的 #bug-reports 中报告。我们会倾听任何反馈，并对此表示衷心的感谢。 ## 总体信息： ### 不兼容： 如果还安装了更改聊天消息的插件，当与 CogWorks 聊天消息交互时，可能会出现消息取消的问题。 一个例子是任何不显示聊天报告的插件。
如果您是其中一个插件的作者，或者对如何解决此问题有任何想法，请通过 [discord](https://discord.gg/3CC6kVcdQH) 联系 tye。 ### 下载： 插件的最新公开版本始终可在 [Modrinth](https://modrinth.com/plugin/file-manager) 和 [GitHub](https://github.com/Mapty231/CogWorks/releases) 上获取。 或者，您可以加入 [discord](https://discord.gg/3CC6kVcdQH) 以查看是否有任何快照构建可供您玩弄！ ### 命令： - "/plugin help" - §a显示帮助消息。 - "/plugin install " - 从 url 下载文件到 "./plugins" 文件夹。 - "/plugin search <插件名称>" - 使用 Modrinth 搜索给定的名称并返回结果，您可以通过选择结果来下载。 - "/plugin browse" - 允许用户搜索 modrinth 上最受欢迎的与您的服务器类型兼容的插件并使用按钮安装它们。 - "/plugin reload" - 强制 CogWorks 重新扫描 "./plugins" 文件夹。 - "/plugin remove <插件名称>" - 禁用并卸载给定的插件。 - "/file help - 显示此消息。 - "/file chat - (WIP) 将您的聊天变成一个模拟命令行，让您可以在服务器上与文件交互。 - "/file gui - 打开一个库存，让您能够以可视化的方式与服务器上的文件交互。 - "/file recover <已删除文件> <还原路径> - 将已删除的文件还原到给定的路径，如果未给出路径，则将文件还原到服务器文件夹。 ### 功能： - 使用 "/plugin install \" 从 Web 安装 jar 文件 - 使用 "/plugin browse" 或 "/plugin search \" 从 Modrinth 安装插件。 - 在从 Modrinth 下载时，将自动安装插件的依赖项。 - 如果 CogWorks 检测到任何未满足的依赖项，将在启动时尝试满足未满足的依赖项。 如果您连接速度慢或带宽有限，请在配置文件中禁用此功能。 - 使用 "/plugin remove \" 删除插件。 - 删除插件时，会提示是否删除插件的配置文件，并且会提示是否删除依赖于要删除的插件才能运行的插件。 - 使用 "/file" 访问 GUI 文件资源管理器。 - 通过仅输入聊天回复来与插件进行交互的独特方式。 不需要命令！ - 支持权限。 - 支持 "/reload"。 ### 权限： - cogworks.plugin.ins.gen - 能够使用 "/plugin install \" 命令从任何 URL 安装插件。 - cogworks.plugin.ins.modrinth - 能够使用 "/plugin search \" & "/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 将使用哪个语言文件。 如果您想通过将插件语言文件翻译成任何新的语言（对于旧版本或当前版本）来提供帮助，请加入 [discord 服务器](https://discord.gg/3CC6kVcdQH) 并 ping @IWantToTranslate。 要找出可以使用哪些值，请遵循配置文件中的链接。 或者，请遵循 [此](https://github.com/Mapty231/CogWorks/tree/master/langFiles) 链接，选择与您使用的 CogWorks 版本对应的文件夹，文件名就是可以用的值。 记住在输入文件名时不要包含 ".yml"。 ShowErrorTrace: 这决定了 CogWorks 是否会在发生错误时在控制台中显示错误信息。 此功能在 CogWorks 退出 alpha 和 beta 阶段之前将默认启用。 如果您正在报告 CogWorks 中的错误，则必须在提交错误报告时启用此功能。 将设置为 "true" 以启用此功能或 "false" 以禁用此功能。 请注意，这仅适用于代码中考虑到的错误。 如果未考虑错误，控制台将发送堆栈跟踪，无论如何。 ShowOpErrorSummary: 当具有 op 权限的玩家加入时，此插件自上次重新加载/重启以来发生的严重错误的数量会发送给他们。 将设置为 “true” 以启用此功能或 “false” 以禁用此功能。 ADR: 如果插件在服务器启动时缺少依赖项，CogWorks 将尝试通过将缺失的插件名称（插件名称是 plugin.yml 中指定名称）搜索 Modrinth 来自动解析依赖项。 如果在 Modrinth 上找不到匹配项，则不会再次尝试。 将设置为 “true” 以启用此功能或 “false” 以禁用此功能。 如果您连接速度慢或带宽有限，建议禁用此功能。 KeepDeleted: Time: 已删除的文件应保留多长时间，直到应将其删除。 给定的值应使用格式：{数字}w 表示周，{数字}d 表示天，{数字}h 表示小时，{数字}m 表示分钟。 例如：“1d3h”。 这将使文件最多保留一天和三个小时。 如果您不希望根据时间删除文件，请将此设置为“-1”。 Size: 还原文件夹的最大尺寸。 如果超过此值，则最旧的文件将被删除，直到尺寸低于指定值。 如果已删除的文件大于指定尺寸，则会立即删除该文件，并且还原文件夹中已有的文件不受影响。 该值应使用格式：{数字}g 表示千兆字节，{n}m 表示兆字节，{n}k 表示千字节。 例如：“100m20k”。 这将确保还原文件夹的大小不会超过一百兆字节和二十千字节。 如果您不希望根据还原文件夹的大小删除文件，请将此设置为“-1”。 ### 未来计划： - 支持从其他网站下载插件。 - 基于聊天的文件管理器。 - 允许使用 URL 一次性安装多个插件。 - 修复使用插件安装时，如果用户在快速重复输入插件版本的选择数字时，插件会被安装两次（但仍然只有一个文件会显示）。 - 在服务器更新时，尝试为服务器安装正确的版本插件。 - 允许发送者在“/plugin browse”时传递一个偏移量？ - 在 op 加入时发送语言更新消息。 - 允许用户退出/返回所有状态。 - 制作语言更新需要确认才能消失？ - 在 "/file gui" gui 中使用户免疫。 - 限制文件 gui 标题的字符限制，以便它不会溢出（从开头删除字符？）。 - 在 ADR 中运行插件，这些插件是从 URL 安装的。 ## 更多阅读： 本节将包含更多技术细节，供感兴趣的人员参考，或者在无需阅读代码的情况下进行介绍。 ### 关于聊天交互： 使用 CogWorks 时，您可能会很快注意到它处理玩家与命令交互的一种非常独特的方式。 例如，在与 "/plugin search " 交互时，CogWorks 将向用户发送多条消息，以 "number:" 开头的消息是可以选择的选项。 要选择其中一个选项，只需在聊天中发送 “number”，无需任何 "/" 或其他命令。 CogWorks 将阻止聊天消息发送给其他用户。 此外，在 "/plugins search " 和 "/plugin browse" 中，发送给您的带有下划线的消息将包含指向它们的超链接。 例如，可以使用“[1: 简单语音聊天](https://modrinth.com/mod/simple-voice-chat)”，该链接将带您访问 Modrinth 上 Simple Voice Chat 插件的主要页面。 另一个发生这种情况的地方是在存在多个有效插件版本时，此时提供的链接将带您到 Modrinth 上该特定插件版本的页面。 链接将始终带您到一个相关的地点以获取有关您想要选择的选项的更多信息。 ### 关于 "/plugin install \"： 对于此命令，下载文件的文件扩展名将始终设置为 ".jar"。 另外，请注意，您必须获取实际文件下载的 URL。 而不是指向可以下载文件的网站的 URL，或者指向插件信息页面的 URL。 例如： 正确：https://cdn.modrinth.com/data/9eGKb6K1/versions/8sbc8kD8/voicechat-bukkit-2.4.27.jar 错误：https://modrinth.com/plugin/simple-voice-chat/version/bukkit-2.4.27 错误：https://modrinth.com/plugin/simple-voice-chat/ 错误：https://modrinth.com 判断是否为文件的一个简单方法是检查 URL 是否以 ".jar" 结尾。 但是，请注意，并非所有插件下载链接都以 ".jar" 结尾！ ### 关于 "/plugin search \"： 对于此命令，查询 **可以** 包含空格，并且仍然被视为单个有效的搜索请求。 此外，任何会导致无法创建有效 URL 的字符都会自动转换为 URL 使用的 [百分号编码](https://en.wikipedia.org/wiki/Percent-encoding)。 ### 关于 "/plugin browse"： 对于此命令，它将让 (正如其名称所示) 浏览 modrinth 上最受欢迎的与您的服务器类型和版本兼容的插件。 使用 "0" 和最大值作为“滚动”列表选项的选项，其中 "0" 输入会向上滚动（如果适用），反之亦然 max number。 ### 关于 "/plugin reload"： 此命令将使 CogWorks “重新扫描” "./plugins" 文件夹，以查找未通过 CogWorks 完成的任何更改。 ### 关于 "/plugin remove \"： 此命令仅在删除队列中没有更多插件后才会执行删除（删除队列只是需要用户输入选项以评估的插件列表）。 此命令的工作方式是让您可以选择要删除的 "./plugins" 文件夹中的任何插件（这包括加载不成功的插件）。 如果选定的插件具有配置文件夹（“./plugins/”），它将提示您是否也删除该文件夹。 然后，如果存在依赖于即将删除的插件的其他插件，将显示一个提示，询问您是否只想删除此插件，删除依赖于此插件的插件，或者退出。 对于删除依赖于此插件的插件的选项，将插件添加到删除队列，因此将针对您选择删除的所有插件执行配置检查和依赖检查。 ### 关于 "/file" 或 "/file gui"： 此命令将打开一个玩家的库存，该库存允许他们查看和管理以服务器文件夹路径开头的路径的文件和文件夹。 例如，假设服务器 jar 位于 "D:\paperSever"（这同样适用于 linux 系统，我只是使用 Windows 文件路径作为示例）。 文件 "D:\paperSever\server.properties" 和 "D:\paperSever\world\playerdata" 是用户可以访问的文件，因为它们的路径以服务器文件夹的路径开头。 但是，文件 "D:/taxInformation" 和 "C:\Program Files" 无法访问，因为它们的路径不同于服务器文件夹路径。 所有文件都将以白色羊毛表示，物品 Lore 是“文件”，所有文件夹都将以黄色羊毛表示，Lore 是“文件夹”。 但是，请注意，物品 Lore 文本可以更改为语言文件。 并且物品名称对应于文件名。 当用户单击文件夹时，库存将更改为显示文件夹的内容，反之亦然，文件。 要返回，只需单击箭头。 对于查看文件，用户可以将鼠标悬停在纸张上以查看某一行文本的片段。 并且可以使用顶部的小箭头来上下滚动文件。 标牌将显示屏幕顶部行的行号。 书和笔可以让一个人搜索文件中的特定短语，并且对于在输入搜索短语时出现的奇怪字符，不要担心，它只是在那里，因此纸张不是“paper”，它将被自动删除。 并且使用光谱箭头可以立即选择行号。 要编辑文件的内容，您必须查看它，然后如果要更改已写定的某些文本，只需单击名为文本的项目名称的纸张， anvil 将打开以让您将文本重命名为任何内容。 要在现有行或行的末尾添加文本，只需单击同一行中的任何空槽，anvil 菜单将再次打开，并且将您在 anvil 中输入的任何文本都将添加到该行。 要删除文本，只需像编辑文本一样做，只是在 anvil 内部删除其中的所有内容。 要创建文件或文件夹，请单击绿色混凝土，这将让您进入“创建模式”。 然后，将打开 anvil 菜单，您可以设置文件名。 请确保不要输入不允许在文件名中使用的字符！ 要删除文件或文件夹，请单击红色混凝土，这将让您进入“删除模式”。 为了清楚地让用户知道，文件的颜色将变为橙色，文件夹的颜色将变为红色。 然后只需单击文件或文件夹以打开删除确认菜单，然后单击绿色混凝土以删除文件或文件夹。 如果尝试删除包含文件或文件夹的文件夹，将有一个额外的确认步骤。 ### 关于 "/file restore \ \"： 当文件被删除时，它们将被存储在 "{serverFolder}/plugins/.data/deletePending" 中，直到满足文件删除要求或使用此命令恢复为止。 所选的文件将被还原到给定的还原路径，如果给定的路径是一个文件夹，则文件将被放置在文件夹中，并带有其原始名称。 如果还原路径以文件名结尾，则该文件将被重命名并移动到还原路径。 ### 关于自动依赖解析： 自动依赖解析 (这将被称为 ADR) 涉及 CogWorks 在启动时检查任何缺失的依赖项，并尝试通过获取缺失的插件名称（插件名称是 plugin.yml 中指定名称）并在 Modrinth 上搜索它来解析它们。 然后它将顶插件（Modrinth 返回的插件）下载到“CogWorks/.temp/ADR/”，并检查下载插件的插件名称是否与缺失依赖项的插件名称匹配。 如果找到匹配的插件，则将其移动到“./plugins”文件夹中。 将删除其余插件。 如果 ADR 在没有错误的情况下完成，但依赖项仍然未解决，则它将不会再次尝试解析该依赖项。 ## 翻译人员招募！ 如果您愿意通过将插件语言文件翻译成任何新的语言（对于旧版本或当前版本）来提供帮助，请加入 [discord 服务器](https://discord.gg/3CC6kVcdQH) 并 ping @IWantToTranslate。