# NClaim - CHUNK-BASED CLAIM PLUGIN ✨
> **_To use this plugin, you need PLACEHOLDERAPI plugin!_**
## What is NClaim?
NClaim 是一个 **高度可定制** 的服务器区块声明插件,专为 **Minecraft 服务器** 设计,旨在 **保护玩家的建筑和物品**。 凭借诸如 **合作声明**、**声明到期**、**世界黑名单** 和 **灵活的配置系统** 等功能,NClaim 为 **服务器管理员** 和 **玩家** 提供 **强大的解决方案**。
## Features
> 🏷️ **声明区块**: 玩家可以 **声明区块** 来保护他们的建筑和物品。
> 🛡️ **声明管理**: 玩家可以远程 **查看、扩展、延续或删除** 自己的声明。
> 👥 **合作系统**: **将朋友添加到您的声明**,并为每个合作成员 **设置单独的权限**。
> ⏳ **声明到期**: 除非延长,否则声明会在可配置的周期后 **自动过期**。
> 🌍 **世界黑名单**: **防止在指定的维度中声明**。
> 🗺️ **区域黑名单 (WorldGuard)**: **阻止在特定的 WorldGuard 区域中声明**,以获得额外的控制。
> 🔑 **高级权限**: 完善的 **权限系统**,适用于玩家和管理员。
> 🛠️ **高度可配置**: 通过配置文件 **自定义消息、GUI 文本、声明设置和插件行为**。
> 🧩 **PlaceholderAPI 支持**: **使用各种占位符来获取游戏内信息和进行外部集成**。
> 🌾 **农场支持**: **自动收集您声明内的农场**,并支持流行的GEIK农场插件。
> 📦 **灵活存储**: 支持 **YAML、SQLite 和 MySQL** 用于声明数据存储。
## Commands
| 命令 | 描述 |
|------------------------|---------------------------------------------------------------------------------------------------------------|
| `/nclaim help` | 显示所有可用的 NClaim 命令列表。 |
| `/nclaim balance` | 显示您当前的声明区块余额。 |
| `/nclaim level` | 计算您的声明区块价值并显示您当前的声明等级。 |
| `/nclaim about` | 提供有关该插件和其版本的信息。 |
| `/nclaim admin` | 显示所有特定于管理员的命令列表。 |
| `/nclaim admin menu` | 打开管理员控制面板,用于高级设置和管理。 |
| `/nclaim admin add balance
` | 向玩家的余额添加指定数量的声明区块。 |
| `/nclaim admin add blacklisted_region ` | 将 WorldGuard 区域添加到黑名单 (需要安装 WorldGuard)。 |
| `/nclaim admin add blacklisted_world ` | 将一个世界黑名单,防止在该世界中声明。 |
| `/nclaim admin add blockvalue ` | 向区块价值列表添加一个新的方块类型,并指定其值。 |
| `/nclaim admin remove balance ` | 从玩家的余额中删除指定数量的声明区块。 |
| `/nclaim admin remove blacklisted_region ` | 从黑名单中删除 WorldGuard 区域。 |
| `/nclaim admin remove blacklisted_world ` | 从黑名单中删除一个世界,允许在该世界中声明。 |
| `/nclaim admin remove blockvalue ` | 从区块价值列表中删除一个方块类型。 |
| `/nclaim admin change blockvalue ` | 更改区块价值列表中现有方块类型的值。 |
| `/nclaim admin change lang ` | 更改插件语言。 (需要 `/nclaim admin reload` 才能生效。) |
| `/nclaim admin set blockvalue ` | 为区块价值列表中特定的方块类型设置值。 |
| `/nclaim admin set balance ` | 将玩家的声明区块余额设置为指定数量。 |
| `/nclaim admin reload` | 重新加载所有 NClaim 配置文件并应用更改。 |
## Permissions
> 版本列显示占位符添加的版本(例如 1.3.1 表示在 1.3.1 及更高版本中添加)
| 权限 | 描述 | 默认 | 版本 |
|------------------------------------|----------------------------------------------------------------------|-----------|---------|
| nclaim.help | 访问帮助命令 | false | 1.0 |
| nclaim.balance | 查看声明余额 | false | 1.0 |
| nclaim.buy | 购买新的声明 | false | 1.0 |
| nclaim.admin | 访问所有管理员命令 | false | 1.0 |
| nclaim.reload | 重新加载插件配置 | false | 1.0 |
| nclaim.add | 访问 /nclaim admin add 命令 | false | 1.0 |
| nclaim.remove | 访问 /nclaim admin remove 命令 | false | 1.0 |
| nclaim.set | 访问 /nclaim admin set 命令 | false | 1.0 |
| nclaim.change | 更改插件设置(语言,区块值等) | false | 1.0 |
| nclaim.bypass.* | 访问所有绕过权限 | false | 1.0 |
| nclaim.bypass.claim_buy_price | 绕过声明购买价格 | false | 1.0 |
| nclaim.bypass.land_buy_price | 绕过土地购买价格 | false | 1.0 |
| nclaim.bypass.max_claim_count | 绕过最大声明数量限制 | false | 1.3 |
| nclaim.adminmenu | 访问管理员菜单 | false | 1.3.1 |
| nclaim.bypass.blacklisted_worlds | 绕过世界黑名单限制 | false | 2.0 |
| nclaim.bypass.blacklisted_regions | 绕过区域黑名单限制 | false | 2.0 |
| nclaim.bypass.pvp | 绕过声明中的 PvP 限制 | false | 2.0 |
| nclaim.bypass.interact | 绕过声明中的交互限制 | false | 2.0 |
| nclaim.bypass.break | 绕过声明中的方块破坏限制 | false | 2.0 |
| nclaim.bypass.place | 绕过声明中的方块放置限制 | false | 2.0 |
| nclaim.maxclaim. | 设置玩家的最大声明数量 (权限节点) | false | 2.0 |
| nclaim.use | 访问基本插件功能(购买声明,管理声明等) | true | 2.0 |
| nclaim.level | 查看声明等级和信息 | false | 2.0 |
| nclaim.* | 所有插件权限 | op | 2.0 |
| nclaim.bypass.max_coop_count | 绕过最大合作玩家数量限制 | false | 2.1 |
| nclaim.manage_claim_block | 访问打开声明区块管理器菜单 | false | 2.1 |
| nclaim.maxcoop. | 设置声明所有者的最大合作玩家数量 (权限节点) | false | 2.1 |
| nclaim.bypass.axsellwand | 绕过声明中的 AxSellWand 使用限制 | false | 2.1.4 |
## Placeholders
> 版本列显示占位符添加的版本(例如 2.0 表示在 2.0 及更高版本中添加)
| 占位符 | 描述 | 版本 |
|--------------------------------------------------------|--------------------------------------------------------------------------------------|----------------------|
| `%nclaim_player_balance%` | 显示玩家的余额 (Vault 或该插件自己的系统) | 1.0 |
| `%nclaim_get_string_path%` | 从 `config.yml` 获取字符串值(`path` = config 键) | 1.0 |
| `%nclaim_get_int_path%` | 从 `config.yml` 获取整数值(`path` = config 键) | 1.0 |
| `%nclaim_get_boolean_path%` | 从 `config.yml` 获取布尔值(`path` = config 键) | 1.0 |
| `%nclaim_get_list_path_index%` | 从 `config.yml` 获取列表值(按索引)(`path` = 键,`index` = 位置) | 1.0 |
| `%nclaim_expiration_world_chunkX_chunkZ%` | 显示给定世界中在 X、Z 区块坐标处的声明到期时间 | 1.0 |
| `%nclaim_owner_world_chunkX_chunkZ%` | 显示给定世界中在 X、Z 区块坐标处的声明所有者 | 1.0 |
| `%nclaim_coop_count_world_chunkX_chunkZ%` | 显示给定世界中在X、Z区块坐标处的声明的合作成员数量 | 1.0 |
| `%nclaim_total_size_world_chunkX_chunkZ%` | 显示给定世界中在X、Z区块坐标处的声明的总区块数 | 1.0 |
| `%nclaim_claim_main_value_world_chunkX_chunkZ%` | 获取给定世界、X、Z 坐标处的声明主区块的方块值 | 2.0 |
| `%nclaim_claim_total_value_world_chunkX_chunkZ%` | 获取给定世界、X、Z 坐标处声明中所有区块的总值 | 2.0 |
| `%nclaim_block_value_material%` | 获取指定方块材料的配置值(例如 `diamond_block`) | 2.0 |
| `%nclaim_owner%` | 显示玩家所在的区块的所有者 | 2.1 |
> 替换变量(如 `path`、`index`、`world`、`chunkX`、`chunkZ`、`material`)为实际值。
> 示例:`%nclaim_block_value_diamond_block%` 或 `%nclaim_get_list_blacklisted_worlds_0%` 或 `%nclaim_total_size_world_0_0%`
## Configuration Example
以下是 `config.yml` 中的一个示例:
```yaml
# World Restrictions
# Configure which worlds and WorldGuard regions are restricted from claiming
blacklisted_worlds:
- world # Example: Main world
- spawn # Example: Spawn world
- pvp # Example: PvP arena world
blacklisted_regions:
- spawnarea # Example: spawn protection area
# Claim Settings
claim_settings:
max_count: 3 # Maximum number of claims per player
buy_price: 1500 # Cost to create a new claim
expand_price: 2000 # Cost to expand an existing claim by one chunk
max_coop_count: # Maximum number of co-op players per claim
default: 3
vip: 5
# Permissions will be need like this "nclaim.max_coop_count.default"
expiry_days: 7 # Days until an inactive claim expires
# Auto-Save Configuration
auto_save: 30 # How often to save data (in minutes)
# Time Extension Settings
time_extension:
price_per_minute: 25.0
price_per_hour: 1500.0
price_per_day: 5000.0
tax_rate: 0.1
# Database Configuration
# Chooses between MySQL and SQLite for data storage
database:
enable: false # Set to true to use database storage instead of YAML
type: "mysql" # Options: "mysql" or "sqlite"
# SQLite Configuration
sqlite:
file: database.db # Database file name
# MySQL Configuration
mysql:
host: localhost
port: 3306
database: nclaim
user: root
password: "" # Replace with your database password
maximum_pool_size: 10 # Maximum number of connections in the pool
minimum_idle: 5 # Minimum number of idle connections
idle_timeout: 300000 # Time (ms) before an idle connection is closed (default: 5 minutes)
max_lifetime: 1800000 # Maximum lifetime (ms) of a connection (default: 30 minutes)
connection_timeout: 30000 # Time (ms) to wait for a connection (default: 30 seconds)
```
## Screenshots
以下是一些插件的截图:











[](https://github.com/aysihuniks/NClaim)
[](https://discord.gg/qcW6YrxwqJ)