原创 闭源 聊天 娱乐 luckyname 1.0.0

# LuckyName 插件使用说明书

## 1. 插件介绍

LuckyName是一个功能强大的Minecraft Paper/Purpur插件，用于自定义玩家名称颜色、Tab菜单内容和聊天格式。支持渐变颜色、权限组系统和丰富的命令。

### 支持版本
- 1.20.1 - 1.21.11

### 核心功能
- 玩家名称颜色设置（支持普通颜色和渐变效果）
- 自定义Tab菜单内容（前缀、后缀）
- 自定义聊天格式
- 权限组系统
- 预设颜色系统
- 玩家信息和列表查询
- 完整的配置文件支持

## 2. 安装说明

### 步骤1：下载插件

```

### 步骤2：安装插件
1. 将`luckyname-1.0.0.jar`文件复制到服务器的`plugins`文件夹
2. 重启服务器或使用`/reload`命令重载插件
3. 插件将自动生成配置文件

### 步骤3：配置插件
编辑`plugins/LuckyName/config.yml`文件，根据需要调整配置选项。

## 3. 配置说明

### 3.1 基础设置
```yaml
basic:
enabled: true # 是否启用插件
prefix: "§a[LuckyName] §r" # 插件消息前缀
debug: false # 是否启用调试模式
```

### 3.2 名称颜色设置
```yaml
name-colors:
enabled: true # 是否启用名称颜色功能
default-color: "§f" # 默认名称颜色
rainbow-enabled: true # 是否启用彩虹渐变
rainbow-speed: 20 # 彩虹渐变速度（tick）
gradient-enabled: true # 是否启用双色渐变
gradient-speed: 10 # 渐变速度（tick）
```

### 3.3 Tab菜单设置
```yaml
tab-menu:
enabled: true # 是否启用Tab菜单功能
allow-player-prefix: false # 是否允许玩家设置自己的Tab前缀
allow-player-suffix: false # 是否允许玩家设置自己的Tab后缀
default-prefix: "" # 默认Tab前缀
default-suffix: "" # 默认Tab后缀
```

### 3.4 聊天格式设置
```yaml
chat-format:
enabled: true # 是否启用聊天格式功能
default-format: "{prefix}{player}{suffix}: {message}" # 默认聊天格式
use-animation-in-chat: true # 是否在聊天中使用动画效果（彩虹/渐变）
```

### 3.5 权限组设置
```yaml
permission-groups:
admin: # 管理员组
prefix: "§4[管理员] §r"
suffix: " §4*"
color: "§c"
chat-format: "{prefix}{player}{suffix}: §c{message}"
vip: # VIP组
prefix: "§6[VIP] §r"
suffix: " §6✯"
color: "§e"
chat-format: "{prefix}{player}{suffix}: §e{message}"
default: # 普通玩家组
prefix: ""
suffix: ""
color: "§f"
chat-format: "{prefix}{player}{suffix}: {message}"
```

## 4. 命令列表

### 4.1 帮助命令
```
/luckyname # 显示帮助信息
/luckyname help # 显示详细帮助
```

### 4.2 颜色设置命令
```
/luckyname color <player> <color> # 设置玩家名称颜色
/luckyname displaycolor <player> <color> # 设置玩家显示名称颜色
/luckyname rainbow <player> # 设置玩家名称为彩虹渐变
/luckyname gradient <player> <color1> <color2> # 设置玩家名称为双色渐变
/luckyname preset <player> <preset> # 使用预设颜色
```

### 4.3 Tab菜单命令
```
/luckyname tabprefix <player> <prefix> # 设置玩家Tab前缀
/luckyname tabprefixclear <player> # 清除玩家Tab前缀
/luckyname tabsuffix <player> <suffix> # 设置玩家Tab后缀
/luckyname tabsuffixclear <player> # 清除玩家Tab后缀
/luckyname tab <player> <prefix> <suffix> # 设置完整Tab信息
/luckyname tabclear <player> # 清除完整Tab信息
```

### 4.4 权限组和聊天命令
```
/luckyname group <player> <group> # 设置玩家权限组
/luckyname chat <player> <format> # 设置玩家聊天格式
```

#### 聊天格式占位符
聊天格式支持以下占位符：
- `{prefix}` - 玩家的Tab前缀
- `{player}` - 玩家名称（带颜色效果）
- `{suffix}` - 玩家的Tab后缀
- `{message}` - 玩家发送的消息
- `{displayname}` - 玩家的完整显示名称

### 4.5 管理命令
```
/luckyname list # 显示在线玩家列表
/luckyname info <player> # 显示玩家详细信息
/luckyname clear <player> # 清除玩家所有设置
/luckyname reload # 重新加载插件
```

## 5. 详细颜色代码列表

### 5.1 普通颜色代码

| 代码 | 颜色名称 | 示例 |
|------|----------|------|
| `§0` | 黑色 | §0黑色 |
| `§1` | 深蓝色 | §1深蓝色 |
| `§2` | 深绿色 | §2深绿色 |
| `§3` | 湖蓝色 | §3湖蓝色 |
| `§4` | 红色 | §4红色 |
| `§5` | 紫色 | §5紫色 |
| `§6` | 金色 | §6金色 |
| `§7` | 灰色 | §7灰色 |
| `§8` | 深灰色 | §8深灰色 |
| `§9` | 蓝色 | §9蓝色 |
| `§a` | 绿色 | §a绿色 |
| `§b` | 青色 | §b青色 |
| `§c` | 粉红色 | §c粉红色 |
| `§d` | 浅紫色 | §d浅紫色 |
| `§e` | 黄色 | §e黄色 |
| `§f` | 白色 | §f白色 |

### 5.2 格式化代码

| 代码 | 效果 | 示例 |
|------|------|------|
| `§l` | 粗体 | §l粗体文本 |
| `§o` | 斜体 | §o斜体文本 |
| `§n` | 下划线 | §n下划线文本 |
| `§m` | 删除线 | §m删除线文本 |
| `§k` | 随机字符 | §k随机效果 |
| `§r` | 重置格式 | §r重置所有格式 |

### 5.3 颜色组合示例

| 组合 | 效果 |
|------|------|
| `§c§l` | 红色粗体 |
| `§a§o` | 绿色斜体 |
| `§9§n` | 蓝色下划线 |
| `§6§m` | 金色删除线 |
| `§d§k` | 紫色随机效果 |
| `§e§l§n` | 黄色粗体下划线 |

### 5.4 渐变色示例

#### 彩虹渐变
使用命令：`/luckyname rainbow <player>`
效果：玩家名称会循环显示彩虹颜色

#### 双色渐变
使用命令：`/luckyname gradient <player> §c §e`
效果：玩家名称在红色和黄色之间交替变化

### 5.5 预设颜色列表

| 预设名称 | 颜色代码 | 效果 |
|----------|----------|------|
| `red` | `§c` | 红色 |
| `green` | `§a` | 绿色 |
| `blue` | `§9` | 蓝色 |
| `yellow` | `§e` | 黄色 |
| `purple` | `§5` | 紫色 |
| `aqua` | `§b` | 青色 |
| `white` | `§f` | 白色 |
| `gray` | `§7` | 灰色 |
| `darkred` | `§4` | 深红色 |
| `darkgreen` | `§2` | 深绿色 |
| `darkblue` | `§1` | 深蓝色 |
| `gold` | `§6` | 金色 |
| `darkpurple` | `§5` | 深紫色 |
| `darkaqua` | `§3` | 深青色 |
| `darkgray` | `§8` | 深灰色 |
| `black` | `§0` | 黑色 |
| `bold` | `§l` | 粗体 |
| `italic` | `§o` | 斜体 |
| `underline` | `§n` | 下划线 |
| `strikethrough` | `§m` | 删除线 |
| `obfuscated` | `§k` | 随机效果 |

## 6. 权限列表

| 权限节点 | 描述 | 默认 |
|----------|------|------|
| `luckyname.use` | 使用基本命令 | OP |
| `luckyname.admin` | 管理员权限 | OP |
| `luckyname.setother.color` | 设置其他玩家颜色 | OP |
| `luckyname.setother.tab` | 设置其他玩家Tab信息 | OP |
| `luckyname.setother.chat` | 设置其他玩家聊天格式 | OP |
| `luckyname.presets` | 使用预设颜色 | OP |
| `luckyname.manage.groups` | 管理权限组 | OP |
| `luckyname.group.admin` | 管理员组权限 | OP |
| `luckyname.group.vip` | VIP组权限 | OP |
| `luckyname.group.default` | 默认组权限 | 所有玩家 |

## 7. 使用示例

### 示例1：设置玩家名称颜色
```
# 设置玩家Steve的名称为红色
/luckyname color Steve §c

# 设置玩家Alex的显示名称为绿色斜体
/luckyname displaycolor Alex §a§o
```

### 示例2：设置Tab信息
```
# 设置玩家Steve的Tab前缀为管理员
/luckyname tabprefix Steve §4[管理员] §r

# 清除玩家Steve的Tab前缀
/luckyname tabprefixclear Steve

# 设置玩家Alex的Tab后缀为VIP
/luckyname tabsuffix Alex §6§l✯

# 清除玩家Alex的Tab后缀
/luckyname tabsuffixclear Alex

# 同时设置前缀和后缀
/luckyname tab Steve §c[Admin] §r §4*

# 清除玩家Steve的完整Tab信息
/luckyname tabclear Steve
```

### 示例3：使用渐变效果
```
# 设置玩家Steve的名称为彩虹渐变
/luckyname rainbow Steve

# 设置玩家Alex的名称在蓝色和紫色之间渐变
/luckyname gradient Alex §9 §d
```

### 示例4：使用预设颜色
```
# 使用预设红色设置玩家名称
/luckyname preset Steve red

# 使用预设粗体设置玩家名称
/luckyname preset Alex bold
```

### 示例5：管理玩家和权限组
```
# 设置玩家Steve为管理员组
/luckyname group Steve admin

# 查看在线玩家
/luckyname list

# 查看玩家详细信息
/luckyname info Steve

# 清除玩家所有设置
/luckyname clear Alex
```

### 示例6：自定义聊天格式
```
# 设置玩家Steve的聊天格式
/luckyname chat Steve §c{player}: §r{message}

# 设置玩家Alex的聊天格式（带前缀后缀）
/luckyname chat Alex {prefix}{player}{suffix}: §a{message}

# 设置玩家Bob的聊天格式（使用显示名称）
/luckyname chat Bob [{displayname}] §7: §r{message}
```

## 8. 配置文件详解

### 8.1 基础配置
```yaml
basic:
enabled: true # 是否启用插件
prefix: "§a[LuckyName] §r" # 插件消息前缀
debug: false # 是否显示调试日志
```

### 8.2 名称颜色配置
```yaml
name-colors:
enabled: true # 是否启用名称颜色功能
default-color: "§f" # 默认名称颜色
rainbow-enabled: true # 是否启用彩虹渐变
rainbow-speed: 20 # 彩虹渐变速度（每20tick更新一次）
gradient-enabled: true # 是否启用双色渐变
gradient-speed: 10 # 双色渐变速度（每10tick更新一次）
```

### 8.3 Tab菜单配置
```yaml
tab-menu:
enabled: true # 是否启用Tab菜单功能
allow-player-prefix: false # 是否允许玩家设置自己的Tab前缀
allow-player-suffix: false # 是否允许玩家设置自己的Tab后缀
default-prefix: "" # 默认Tab前缀
default-suffix: "" # 默认Tab后缀
```

### 8.4 聊天格式配置
```yaml
chat-format:
enabled: true # 是否启用聊天格式功能
default-format: "{prefix}{player}{suffix}: {message}" # 默认聊天格式
use-animation-in-chat: true # 是否在聊天中使用动画效果（彩虹/渐变）
```

#### 聊天格式占位符
| 占位符 | 描述 |
|--------|------|
| `{prefix}` | 玩家的Tab前缀 |
| `{player}` | 玩家名称（带颜色效果） |
| `{suffix}` | 玩家的Tab后缀 |
| `{message}` | 玩家发送的消息 |
| `{displayname}` | 玩家的完整显示名称 |

#### 聊天动画效果
- 当玩家设置了彩虹或渐变效果时，聊天中的玩家名称会自动应用相同的动画效果
- 动画效果会实时更新，与Tab列表中的效果保持一致

#### 权限组聊天格式
每个权限组可以配置独立的聊天格式，示例：
```yaml
permission-groups:
admin:
chat-format: "{prefix}{player}{suffix}: §c{message}" # 管理员聊天消息为红色
vip:
chat-format: "{prefix}{player}{suffix}: §e{message}" # VIP聊天消息为黄色
default:
chat-format: "{prefix}{player}{suffix}: {message}" # 普通玩家聊天消息无特殊颜色
```

### 8.5 权限组配置
```yaml
permission-groups:
# 定义权限组
groupName:
prefix: "" # 组前缀
suffix: "" # 组后缀
color: "§f" # 组颜色
chat-format: "" # 组聊天格式
```

### 8.6 命令配置
```yaml
commands:
main-command-enabled: true # 是否启用主命令
color-command-enabled: true # 是否启用颜色命令
rainbow-command-enabled: true # 是否启用彩虹命令
# 其他命令配置...
```

## 9. 常见问题

### Q: 插件不生效怎么办？
A: 请检查：
1. 插件是否已正确放入plugins文件夹
2. 服务器是否已重启或重载
3. 插件是否在配置中启用（basic.enabled: true）
4. 玩家是否有足够的权限

### Q: 颜色代码不显示怎么办？
A: 请确保：
1. 使用了正确的颜色代码格式（§+字符）
2. 没有忘记使用§r重置格式
3. 颜色代码没有被其他插件覆盖

### Q: 渐变效果不工作怎么办？
A: 请检查：
1. 渐变效果是否在配置中启用
2. 玩家是否在线
3. 是否有足够的权限

### Q: 如何设置多个权限组？
A: 在config.yml中的permission-groups部分添加新的权限组，然后使用`luckyname.group.<groupname>`权限节点分配给玩家。

## 10. 高级功能

### 10.1 权限组继承
玩家可以同时拥有多个权限组，插件会根据权限检查顺序应用第一个匹配的权限组设置。

### 10.2 动态颜色效果
- 彩虹渐变：自动循环所有彩虹颜色
- 双色渐变：在两种颜色之间平滑过渡
- 支持自定义渐变速度

### 10.3 性能优化
- 使用ConcurrentHashMap确保多线程安全
- 动画效果使用Bukkit调度器优化性能
- 仅在线玩家才会更新动画效果

## 11. 更新日志

### v1.0.0
- 初始版本发布
- 支持名称颜色设置
- 支持Tab菜单自定义
- 支持聊天格式自定义
- 支持权限组系统
- 支持渐变颜色效果
- 完整的命令系统
- 详细的配置文件
- 新增Tab信息清除命令：
- `/luckyname tabprefixclear <player>` - 清除玩家Tab前缀
- `/luckyname tabsuffixclear <player>` - 清除玩家Tab后缀
- `/luckyname tabclear <player>` - 清除完整Tab信息

## 12. 联系方式

如有问题或建议，请联系插件开发者。

---

**LuckyName插件 - 让你的Minecraft服务器更加多彩！**