# WeeklyStorage

**Repository Path**: malajis/weekly-storage

## Basic Information

- **Project Name**: WeeklyStorage
- **Description**: 玩家权益物品周目管理插件
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-25
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WeeklyStorage

WeeklyStorage 是一款 Minecraft Bukkit/Spigot 插件，提供**纪念品仓库**和**权益系统**两大核心功能。玩家可以将纪念品存入仓库永久保存，管理员可以管理玩家购买的氪金权益。

## 功能特性

### 纪念品仓库
- **GUI 界面操作**：点击背包物品存入，点击仓库物品取出
- **支持堆叠物品**：自动合并相同物品，支持批量存入/取出
- **存入规则**：物品 Lore 包含指定关键词，或材质在白名单中
- **数据持久化**：完整保存物品名称、Lore、附魔、无法破坏等属性
- **管理员查看**：可以打开其他玩家的仓库进行管理

### 权益系统
- **权益配置**：支持物品奖励和命令奖励
- **自动发放**：玩家进服时自动检测并发放未领取的权益
- **手动领取**：`/ws claim` 领取所有未领取的权益
- **管理员管理**：添加、移除、查看、重置、立即发放等
- **从手中创建**：手持物品执行 `/ws rights create <名称>` 快速创建权益

## 指令

### 玩家指令

| 指令 | 说明 |
|------|------|
| `/ws store` | 打开纪念品仓库 |
| `/ws myrights` | 查看自己拥有的权益 |
| `/ws claim` | 领取所有未领取的权益 |
| `/ws help` | 查看帮助 |

### 管理员指令

| 指令 | 说明 |
|------|------|
| `/ws open <玩家>` | 打开玩家的纪念品仓库 |
| `/ws clear memento <玩家>` | 清空玩家的纪念品仓库 |
| `/ws rights create <名称>` | 从手中物品创建权益 |
| `/ws rights add <玩家> <名称>` | 给玩家添加权益 |
| `/ws rights remove <玩家> [名称\|all]` | 移除玩家权益 |
| `/ws rights list <玩家>` | 查看玩家权益列表 |
| `/ws rights reset <玩家\|all>` | 重置权益发放状态 |
| `/ws rights give <玩家> <名称>` | 立即发放权益物品 |
| `/ws rights grant <玩家> <名称>` | 添加并立即发放权益 |
| `/ws reload` | 重载所有配置 |

### PlaceholderAPI 变量

| 变量 | 说明 | 示例 |
|------|------|------|
| `%weeklystorage_completion%` | 累计通关次数 | 1 |
| `%weeklystorage_threshold%` | 通关阈值 | 10000 |
| `%weeklystorage_previous_level%` | 前周目等级 | 15000 |
| `%weeklystorage_claimed%` | 是否已领取 | true |
| `%weeklystorage_claimed_status%` | 领取状态 | §a已领取 |
| `%weeklystorage_completed%` | 是否通关 | true |
| `%weeklystorage_completed_status%` | 通关状态 | §a已通关 |
| `%weeklystorage_previous_week%` | 前周目名称 | 第一周目 |
| `%weeklystorage_current_week%` | 当前周目名称 | 第二周目 |
| `%weeklystorage_export_enabled%` | 奖励领取开关 | true |

## 配置说明

### config.yml

主配置文件，包含权益系统开关、纪念品仓库规则、语言消息等。

```yaml
# 权益系统配置
rights:
  enabled: false                    # 是否开启权益自动发放
  rights-file: "rights.yml"         # 权益配置文件
  data-file: "rights_data.yml"      # 玩家权益数据文件
  claimed-file: "rights_claimed.yml" # 已发放记录文件

# 纪念品仓库配置
memento:
  allowed-lore:                     # 允许存入的Lore关键词
    - "纪念品"
    - "◆"
    - "抽奖"
  allowed-materials:                # 允许存入的材质列表
    - "DRAGON_EGG"
    - "DRAGON_HEAD"
    - "PLAYER_HEAD"
  max-size: 54                      # 仓库大小（最大54）
  gui-title: "§8§l纪念品仓库"        # GUI标题
  data-folder: "memento"            # 数据存储目录
  allow-duplicate: true             # 是否允许重复存入相同物品

# 语言配置
messages:
  prefix: "§8[§6周目权益§8] "       # 消息前缀
  # ... 其他消息配置
```

### rights.yml

权限配置文件，定义各权限 ID 对应的名称和可用命令。

```yaml
# 权益配置示例
氪金镐:
items:
- material: DIAMOND_PICKAXE
amount: 1
meta:
display-name: "§6§l氪金镐"
lore:
- "§7这是一把氪金镐"
- "§e无限耐久"
enchants:
DURABILITY: 3
DIG_SPEED: 5
unbreakable: true
commands: []

VIP称号:
items: []
commands:
- "lp user {player} permission set chat.prefix.vip true"
```

## 常见问题

**Q: 如何创建权益？**  
A: 手持物品，执行 `/ws rights create <权益名称>`，物品的完整属性（名称、Lore、附魔、无法破坏等）都会被保存。

**Q: 玩家如何领取权益？**  
A: 玩家执行 `/ws claim` 领取所有未领取的权益。也可以开启自动发放（rights.enabled: true），玩家进服时自动领取。

**Q: 纪念品仓库如何存入物品？**  
A: 执行 `/ws store` 打开仓库，点击背包中的物品即可存入。只有包含指定Lore或材质在白名单中的物品才能存入。

**Q: 如何管理玩家数据？**  
A:
- 编辑玩家纪念品仓库：`/ws open <玩家>`
- 清空纪念品仓库：`/ws clear memento <玩家>`
- 清空所有权益：`/ws rights remove <玩家> <名称|all>`
- 清空所有领取记录：`/ws rights reset <玩家|all>`

## 安装方法

1. 将编译后的 `.jar` 文件放入服务器的 `plugins` 文件夹
2. 重启服务器或使用 `/plugman load plugin` 加载插件
3. 插件会自动生成必要的配置文件

## 权限节点

- `weeklystorage.use` - 使用存储功能的权限
- `weeklystorage.admin` - 管理权限