# LG精灵图鉴

**Repository Path**: langle123/LGPokedex

## Basic Information

- **Project Name**: LG精灵图鉴
- **Description**: 方块宝可梦图鉴
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-10
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, Bukkit, Minecraft, Cobblemon

## README

# LGPokedex 插件文档

## 🌟 项目概述

**LGPokedex** 是一款为 Minecraft
服务器开发的插件，专用于增强玩家对宝可梦（Pokémon）图鉴的管理和交互体验。该插件基于 [Cobblemon Mod](https://cobblemod.com/)
开发，支持玩家查看、授予和撤销图鉴，并提供丰富的 GUI 界面操作功能。

---

## 🧩 功能特性

- **图鉴管理**
    - `/lgpokedex grant`：给予玩家完整的图鉴。
    - `/lgpokedex revoke`：移除玩家的图鉴。
    - `/lgpokedex open`：打开图鉴界面。
    - `/lgpokedex reload`：重新加载配置文件。

- **GUI 界面**
    - 提供直观的图形用户界面，展示所有世代的宝可梦。
    - 支持点击领取奖励、切换世代等功能。
    - 可自定义过滤器，如隐藏已收集/未收集精灵。

- **奖励系统**
    - 每个世代可以配置不同的奖励命令（例如给予物品）。
    - 奖励通过右键点击按钮触发。

- **数据持久化**
    -
    使用 [LRUCacheMap](common/src/main/java/lg/minecraft/plugin/pokedex/util/LRUCacheMap.java)
    缓存玩家数据，定期保存到磁盘。
    - 支持配置文件热重载，无需重启服务器即可生效新配置。

---

## ⚙️ 运行环境

| 组件            | 版本要求                 |
|---------------|----------------------|
| Java          | JDK 21               |
| Minecraft     | 1.21.1               |
| Cobblemon Mod | 1.6.1+1.21.1         |
| Spigot API    | 1.21.1-R0.1-SNAPSHOT |
| Lombok        | 1.18.34              |

---

## 📁 项目结构

```
src/
├── main/
│   ├── java/
│   │   └── lg.minecraft.plugin.pokedex/
│   │       ├── command/        # 命令处理类
│   │       ├── config/         # 配置文件类
│   │       ├── gui/            # GUI 界面相关类
│   │       ├── listener/       # 事件监听器
│   │       ├── manager/        # 玩家数据管理类
│   │       ├── task/           # 定时任务类
│   │       ├── util/           # 工具类
│   │       ├── Generations.java # 宝可梦世代枚举
│   │       ├── LGPokedex.java  # 主插件类
│   │       └── PokedexPlayer.java # 玩家图鉴状态类
│   └── resources/
│       ├── config.yml          # 主配置文件
│       ├── message.yml         # 消息配置文件
│       ├── plugin.yml          # 插件元信息
│       └── reward.yml          # 奖励配置文件
```

---

## 📜 配置说明

### `plugin.yml`

```yaml
name: LGPokedex
version: '${project.version}'
main: lg.minecraft.plugin.pokedex.LGPokedex
api-version: '1.21'
authors: [ langle__ ]
depend:
  - LGLibrary
permissions:
  LGPokedex.command:
    default: true
  LGPokedex.command.open:
    default: op
  LGPokedex.command.reload:
    default: op
  LGPokedex.command.revoke:
    default: op
  LGPokedex.command.grant:
    default: op
```

### `reward.yml`

```yaml
gen1:
  addLore:
    - "• 钻石 x1"
    - "• 绿宝石 x2"
    - "• 金锭 x5"
    - "• 下界合金锭 x1"
  commands:
    - "minecraft:give {player} minecraft:diamond 1"
    - "minecraft:give {player} minecraft:emerald 2"
    - "minecraft:give {player} minecraft:gold_ingot 5"
    - "minecraft:give {player} minecraft:netherite_ingot 1"
    - "minecraft:execute as {player} at @s run playsound minecraft:ui.toast.challenge_complete master @s ~ ~ ~ 0.8 1 0"
...
```

---

## 🔧 使用指南

### 安装步骤

1. 将 `LGPokedex.jar` 文件放入你的 Minecraft 服务器插件目录。
2. 启动服务器以生成配置文件。
3. 根据需要编辑 `plugins/LGPokedex/config.yml` 和 `plugins/LGPokedex/reward.yml`。
4. 重启服务器或使用 `/lgpokedex reload` 命令使配置生效。

### 常用命令

| 命令                     | 权限                         | 功能描述      |
|------------------------|----------------------------|-----------|
| `/lgpokedex` 或 `/lgpd` | `LGPokedex.command`        | 打开主菜单     |
| `/lgpokedex open`      | `LGPokedex.command.open`   | 打开图鉴界面    |
| `/lgpokedex grant`     | `LGPokedex.command.grant`  | 授予图鉴给当前玩家 |
| `/lgpokedex revoke`    | `LGPokedex.command.revoke` | 移除当前玩家的图鉴 |
| `/lgpokedex reload`    | `LGPokedex.command.reload` | 重新加载配置文件  |

---

## 🛠️ 开发与扩展

### 自定义奖励

在 reward.yml 中，你可以为每个世代配置不同的奖励命令，例如：

```yaml
gen7:
  addLore:
    - "• 钻石 x4"
    - "• 绿宝石 x7"
  commands:
    - "minecraft:give {player} minecraft:diamond 4"
    - "minecraft:give {player} minecraft:emerald 7"
```

### 添加新的世代支持

你可以通过修改 `Generations.java` 文件来添加新的世代，并在 `GenInventory.java` 中实现相应的 GUI 逻辑。

---

## 📦 Maven 依赖

```xml

<dependencies>
    <dependency>
        <groupId>com.cobblemon</groupId>
        <artifactId>mod</artifactId>
        <version>1.6.1+1.21.1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.spigotmc</groupId>
        <artifactId>spigot-api</artifactId>
        <version>1.21.1-R0.1-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>lg.minecraft.plugin.library</groupId>
        <artifactId>LGLibrary</artifactId>
        <version>1.1.6</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

---

## 📝 注意事项

- 确保你已经安装了正确的 Cobblemon Mod 版本。
- 所有命令都需要适当的权限才能执行。
- 修改配置后请务必使用 `/lgpokedex reload` 命令使其生效。

---

## 📬 联系方式

如果你有任何问题或建议，请联系作者 `langle__` 或提交 Issue 到 GitHub 仓库。

--- 

**LGPokedex** 提供了一个强大且易于使用的工具，帮助你在 Minecraft 世界中更好地管理和探索宝可梦！🎉