Codex - 探索日志

简介

Codex 是一款为 Minecraft 服务器增添 RPG 体验的插件，它允许你创建一个“发现”系统。玩家可以通过首次进入特定区域、与 NPC 对话、击败怪物等方式解锁各种发现，从而了解服务器世界中的背景故事与设定。插件提供了高度可定制的配置选项，包括发现内容、解锁方式、奖励以及展示界面。

💡重要更新须知

如果你正在从 1.X 版本更新

• Codex 已完全重写，相当于一个全新的插件，带来了大量改进与修复。
• 在更新前，你必须删除整个旧的 Codex 插件文件夹。 这将导致你原有的所有发现记录和配置丢失。
• 由于改动过大，无法提供数据迁移系统。请务必提前备份重要配置文本，以便在新版本中重新使用。
• 全新的 Wiki 文档已同步更新，详细说明了插件当前的工作方式：https://ajneb97.gitbook.io/codex

🎮核心功能

发现系统

• 可创建任意自定义的“发现”条目，为玩家提供关于区域、人物、怪物等的背景信息。
• 每个发现条目包含：

-   名称与描述

-   分类

-   解锁日期记录

• 支持对已解锁的发现条目设置点击动作。

解锁方式

发现可以通过多种途径解锁

• 首次进入 WorldGuard 区域
• 击杀原版生物
• 击杀 MythicMobs 生物
• 使用管理员命令手动解锁

奖励系统

当玩家解锁发现时，可以触发多种奖励

• 发送聊天信息
• 执行控制台命令
• 播放音效
• 显示标题消息

库存界面

• 完全可配置的发现展示界面（库存）。
• 支持多页面/多库存。
• 可自定义各类界面物品：

-   分类物品

-   已解锁物品

-   未解锁（锁定）物品

其他特性

• 支持 MySQL 数据库。
• 支持 PlaceholderAPI 变量。
• 内置插件错误检查系统 (/codex verify)。
• 兼容 1.16.5 及以上版本。

🔧命令与权限

命令列表

• /codex - 打开主菜单。
• /codex unlock - 为指定玩家解锁一个发现。
• /codex resetplayer - 重置指定玩家的发现进度。
• /codex open - 为玩家打开指定的发现库存界面。
• /codex reload - 重载插件配置。
• /codex verify - 检查插件配置是否存在错误。

权限节点

• codex.admin - 授予使用所有插件命令的权限。

❓支持与帮助

作者支持

如需帮助或联系作者，请通过以下方式

• 在本插件的 SpigotMC 讨论区发帖。
• 在 SpigotMC 上向作者发送私信。
• 在 GitHub 上提交 Issue。

社区支持（Discord）

• 这是一个主要由西班牙语用户组成的社区支持 Discord 服务器。
• 服务器内设有“Plugins Ajneb97”分类，其中包含西语和英语支持频道。
• 你可以在 general-plugins-ajneb97 频道中寻求帮助。请注意，此频道的支持主要来自其他用户，作者不保证会在此直接回复。
• 如需作者直接帮助，建议优先使用讨论区或私信功能。

文档与进阶

• 完整 Wiki 文档：https://ajneb97.gitbook.io/codex
• 若要创建高度定制化的发现（例如基于复杂条件），建议搭配使用作者的另一个插件 ConditionalEvents，相关教程可在 Wiki 中找到。

Codex – 服务器任务与进度系统

Codex 是一个为 Minecraft 服务器设计的任务与进度系统。它允许服务器管理员创建自定义任务、进度和成就，玩家可以通过完成它们来获得奖励。该系统支持多种任务类型，并与 PlaceholderAPI 集成，提供了高度的可定制性。

💡主要特性

• 多种任务类型：支持击杀、挖掘、放置、合成、钓鱼、交易、行走、酿造、附魔、丢弃、拾取、喝牛奶、吃食物、使用物品、骑马、剪羊毛、繁殖动物、驯服动物、挤奶、剪蘑菇、穿戴装备、玩家死亡、玩家击杀、方块交互、自定义事件等多种触发条件。
• 进度与成就系统：任务可以组织成进度（Progressions）和成就（Achievements），形成清晰的解锁路径。
• 丰富的奖励：完成任务可给予玩家物品、金钱（Vault）、经验、命令执行、进度解锁、发送消息等多种奖励。
• GUI 界面：玩家可以通过直观的图形界面（/codex）查看和管理自己的任务、进度与成就。
• 高度可配置：几乎所有文本、物品、GUI 布局、条件和奖励都可以通过配置文件自定义。
• 数据存储：支持 MySQL 和 SQLite 存储玩家数据。
• PlaceholderAPI 支持：提供丰富的占位符，用于在其他插件中显示任务信息。
• 多世界支持：可以限制任务仅在特定世界生效。
• 多语言支持：内置多种语言文件，易于本地化。

🎮命令与权限

玩家命令

• /codex – 打开主任务菜单。权限：codex.menu
• /codex help – 显示帮助信息。
• /codex info – 查看插件信息。
• /codex reload – 重载插件配置（需要管理员权限）。

管理员命令

• /codex admin – 打开管理员菜单。权限：codex.admin
• /codex admin giveprogress <player> <progression_id> – 给予玩家指定进度。权限：codex.admin.giveprogress
• /codex admin resetprogress <player> <progression_id> – 重置玩家的指定进度。权限：codex.admin.resetprogress
• /codex admin resetall <player> – 重置玩家的所有进度数据。权限：codex.admin.resetall
• /codex admin checktask <player> <task_id> – 检查玩家特定任务的完成情况。权限：codex.admin.checktask
• /codex admin completetask <player> <task_id> – 强制完成玩家的特定任务。权限：codex.admin.completetask
• /codex admin resettask <player> <task_id> – 重置玩家的特定任务。权限：codex.admin.resettask
• /codex admin giveitem <item_id> – 获取配置文件中定义的特定物品。权限：codex.admin.giveitem

🔧快速开始

• 安装插件

- 将 Codex.jar 放入服务器的 `plugins` 文件夹。

- 重启服务器。

• 基础配置

- 首次运行后，在 `plugins/Codex` 文件夹中会生成配置文件。

- 主要配置文件是 `config.yml`，你可以在这里调整全局设置，如数据库、语言和菜单。

- 任务、进度和成就分别在 `tasks.yml`、`progressions.yml` 和 `achievements.yml` 中定义。

• 创建你的第一个任务

- 打开 `plugins/Codex/tasks.yml`。

- 参照示例格式添加一个新任务，例如一个要求玩家挖掘 10 个钻石矿的任务。

- 配置任务名称、描述、类型（`mine`）、目标（`DIAMOND_ORE:10`）以及奖励。

- 保存文件并在游戏内使用 `/codex reload` 重载配置。

• 创建进度

- 打开 `plugins/Codex/progressions.yml`。

- 创建一个新的进度，将上一步创建的任务添加到其任务列表中。

- 设置进度的显示名称、描述、图标和完成奖励。

- 保存并重载。

• 玩家体验

- 玩家输入 `/codex` 即可打开菜单，查看可用的进度和任务。

- 当他们完成挖掘 10 个钻石矿的目标后，任务会自动完成并发放奖励。

✨依赖项

• 必需：Spigot 或 Paper 1.13+
• 推荐：

- **Vault** – 用于提供经济奖励。

- **PlaceholderAPI** – 用于使用 Codex 提供的占位符。

• 可选：MySQL 驱动程序（如果使用 MySQL 数据库）。

❓常见问题

• 如何让任务在多个世界中生效？

- 在任务的配置中，使用 `worlds` 列表来指定有效的世界名称。如果留空或设置为 `"all"`，则在全世界生效。

• 任务进度没有更新怎么办？

- 首先检查任务类型和条件是否配置正确（例如，物品名称、数量）。

- 确认玩家是否在任务指定的有效世界中。

- 使用 `/codex admin checktask <玩家> <任务ID>` 来检查后台数据。

• 如何创建连锁任务（一个接一个）？

- 你可以在 `progressions.yml` 中配置进度。进度内的任务将按列表顺序解锁。只有完成前一个任务，下一个任务才会对玩家可见（如果设置了 `sequential: true`）。

• 支持哪些经济插件？

- 通过 Vault 支持，Codex 兼容大多数主流经济插件，如 EssentialsX、CMI、PlayerPoints 等。

• 如何翻译插件？

- 插件自带多种语言文件（如 `messages_es.yml`, `messages_zh.yml`），位于 `plugins/Codex/languages/` 目录下。你可以复制并修改这些文件，然后在 `config.yml` 中设置 `language: 你的语言文件名`。

• 如何备份玩家数据？

- 如果使用 SQLite，数据文件位于 `plugins/Codex/data.db`，直接复制即可。

- 如果使用 MySQL，请使用你的数据库管理工具进行备份。

⭐提示与高级用法

• 自定义事件：通过 custom 任务类型，你可以让其他插件（或 Codex 自身）触发任务更新。这需要调用 Codex 提供的 API。
• 条件系统：可以为任务、进度和奖励设置条件（如权限、已完成其他进度、时间限制等），使系统更加灵活。
• 物品变量：在任务描述、GUI 物品名称和 lore 中，可以使用变量（如 %task_current_amount%）来动态显示信息。
• API 集成：Codex 提供了完善的 API，方便其他开发者创建扩展或与之交互。详情请查阅开发者文档。

---

**相关链接**

• SpigotMC 资源页面
• GitHub 仓库
• Discord 支持