Minecraft插件百科 - 用户贡献 [zh-cn]

FastLogin

2021-05-16T17:46:05Z

声名我主宰：更改命令样式

{{Plugin Infobox
|icon=[[File:FastLogin.png]]
|plugin=FastLogin
|version=0.43-D
|pre=GeneralDataCoreV5
|ver=Mark.5
|author=KspTooi
|URL=http://www.mcbbs.net/thread-586047-1-1.html
}}
[[Category:娱乐]]
[[Category:管理]]
[[Category:安全]]
[[Category:其它]]
[[Category:综合]]

FastLogin (简称FL) 是一款用于登录的插件.它和现在其他的同类插件相比,FastLogin具有更轻量、灵活、简单、命令少、等特点,除此之外它抛弃了那些无用的配置与功能,并且有经过强化的安全配置和性能优化;它也会随着版本更新而不断添加一些新的功能,这些特点使得它非常适合运行在中小型服务器上.

==插件特性==
* 轻量化配置简单
* 运行速度快
* 不支持权限组
* 支持MD5加密算法
* 支持密码明文存储
* 支持使用.gd文件和Mysql数据库
* 可以自定义玩家加入退出消息
* 能够有效防止影分身BUG
* 支持限制单IP注册上限制
* 可以防止机器人压测
* 支持未登录状态下的OP与创造保护
* 支持未登录失明和登录后产生粒子特效
* 支持中文名. 并兼容自定义正则表达式匹配玩家名
* 可以自定义语言文件

==命令==
{| class="wikitable"
|-
! 指令 !! 介绍 !! 默认使用者
|-
| /login 或/l <密码> || 登录 || Default
|-
| /register 或 /reg <密码> <确认密码> || 注册 || Default
|-
| /ChangePassword <旧密码> <新密码> <确认新密码> || 修改密码 || Default
|-
| /Fast reload || 重载插件配置文件 || OP
|-
| /Fast setSpawn || 将当前位置设为初始登录点 (设置后玩家上线将被强制传送到此) || OP
|-
| /Fast Spawn || 传送到你设置的初始登录点 || OP
|-
| /Fast delSpawn || 删除初始登录点 || OP
|-
| /Fast setPassword || 重置某玩家的密码 || OP
|-
| /TC || 显示插件性能计数 || OP
|}

==权限组==
此插件不支持权限组！

==配置文件==
配置文件位置:/plugins/ksptooi/fastlogin/FastLogin.conf<br>
语言文件位置:/plugins/ksptooi/fastlogin/languageV1.gd

@LineType=GeneralDataCore -禁止修改
@LineVersion=V5 -禁止修改
@KeySeparationSymbol== -禁止修改
#
#基本配置
ConfigVersion=0.43-B-RE -禁止修改
//玩家数据储存类型可选GeneralDataCore | Mysql
PlayerDataType=GeneralDataCore
//登录超时
LoginTimeOut=60
//玩家密码最大长度
PasswordMaxLength=15
//玩家密码最小长度
PasswordMinLength=5
//玩家名称最小长度
PlayerNameMinLength=3
//登录消息的发送间隔
MessageInterval=5
//登录安全保护时间
LoginSecurityTime=3
//开启安全登录, 此选项开启后玩家进服会被立即传送至初始登录点,并在登录后传送回最后下线的位置. 有效防止卡地狱门
Enable_LoginSecurity=false
//开启用户名严格模式,此选项开启后玩家将只能使用含有A-Z 0-9和下划线的名字进入游戏(在1.7版本关闭此选项可以使用中文ID)
Enable_UserNameStrictmode=true
//名称含有某个关键字的玩家将不能进服参考格式=name1;name2;name3;name4(如果不开启填 *;)
BanName=*;
//每个IP的最大注册账号数如不需要填0关闭它.
MaxRegisterIP=0
//使用自定义的正则表达式来匹配玩家名,不符合要求的玩家将无法进服.
RegexMatchForPlayerName=*
#
#特效及自定义配置
//玩家登录成功以后收到的公告如不需要,填false (变量:%Player%玩家名 & 颜色代码 #换行符)
//范本:&A&L欢迎来到&C&LKspTooi&A&L服务器#&A&L请在聊天框输入Login登录#&A&L祝你游戏愉快
PlayerLoginedMessage=false
//自定义玩家的加入消息(变量:%Player%玩家名 )
PlayerJoinedMessage=§e%Player% Joined the game.
//自定义玩家的退出消息(变量:%Player%玩家名 )
PlayerQuitMessage=§e%Player% Left the game.
//开启登录后的粒子效果
Enable_PlayerLoginedEffect=true
//开启登录前的失明效果
Enable_PlayerPreLoginEffect=true
#
#安全配置
//启用OP安全 —— OP在未登录时没有权限
Enable_OPSecurity=true
//启用安全警告——有人利用BUG时后台文字提示
Enable_SecurityWarning=true
//启用地狱门安全
Enable_HellGateSecurity=true
//启用创造安全 —— 拥有创造模式的玩家在未登录时没有权限
Enable_CreativeModeSecurity=true
//密码加密方式如需明文存储密码填写false
Enable_passwordHash=MD5
//支持旧加密方式, 如果密码错误,会用其他加密方法再尝试成功后将会将密码转换为新的加密方式.
Enable_SupportOldPassword=false
//开启调试输出(一般不要动)
Enable_DebugPrint=false
#
GeneralDataCore - Mysql数据库配置
//数据库地址
MysqlAddress=127.0.0.1:3306
//数据库名
DataBaseName=fastlogin
//数据库账号
MysqlUser=root
//数据库密码
MysqlPwd=root
//连接时附加的参数
Param=?useSSL=false§characterEncoding=utf8§serverTimezone=UTC§autoReconnect=true
#
FastLogin - Mysql数据库配置 #玩家数据表
//玩家数据表名
PlayerDataTable=playertable
//用于储存玩家名称的数据库字段名
PlayerNameField=playername
//用于储存玩家密码的数据库字段名
PlayerPwdField=playerpwd
//用于储存玩家注册状态的数据库字段名
PlayerRegStatusField=register
//用于储存玩家登录状态的数据库字段名
PlayerLoginStatusField=login
#
FastLogin - Mysql数据库配置 #玩家位置数据表(!不建议修改)
PlayerLocTable=playerloc
PlayerNameField=Foreign Key
PlayerLocworld=locworld
PlayerLocx=locx
PlayerLocy=locy
PlayerLocz=locz
PlayerLocpitch=locpitch
PlayerLocyaw=locyaw

==开发日志==

0.43-D-RC——增加对版本1.5.x-1.6.x的支持.

0.43-D-RE——新机制:当玩家未登录时点击背包中的物品,将会强制关闭背包界面.

0.43-C-DR——玩家名大小写不一致的问题一直以来都存在,我们的做法是,当玩家使用大写名称注册了账号,那么不论是使用小写名称还是大小写名称混合进服,都会被要求输入大写名称的密码.此时玩家仍然可以继续登录,但是背包和物品栏都和大写名称的不一致,这可能会产生一些不可预料的风险. 在这个版本着重修复了此问题. 现在假如玩家使用名称ABC注册了一个账号,那么他不论是用abc还是aBc都无法登录!

0.43-B-PR——改良了新的数据访问机制.

0.43-A-PR——添加一个性能监测器用于监测插件的运行性能. (命令/TC)

0.42-F-PR——修复一个可能的内存泄漏问题!

0.42-B-PR——测试了在上一个版本的新机制,确保运行稳定.

0.42-A-PR[开发预览版]——新机制/性能更新!:由于现有的数据访问机制在高负载下的性能损失较大. 所以从此版本开始采用新的数据访问机制,添加了一个缓存池用于存储玩家GD数据,而不是从GD文件直接读取数据. 大幅降低了高负载下的IO开销！也彻底修正了某些特殊情况下的IO错误.

0.41-L-RE——增加对版本1.13的支持.

0.41-H-15-RE——修复了1.10版本的兼容性问题.

0.41-H-RE——新特性: 更改了一些命令,并采用新的命令监听方式. 优化了语言文件!

0.41-G-5-RE——重新绘制了插件Logo.

0.41-G-RE——修复一处BUG:当玩家登录时站在(或与仙人掌接触)仙人掌上可能出现的NPE.

GeneralDataCoreV6——架构更新, 新特性:增加线程池,一定程度改善高负载下的性能.进行了一些底层IO优化,也许对性能提升有帮助.

0.41-F-RE——优化配置文件格式,使其更易看懂.

0.41-D-RE—— 将插件中的一些硬编码语言重新添加至语言文件！新特性:玩家登录与注册输入的密码服务器后台将不可见.

0.41-C-RE ——更改了几个命令,方便记忆. 删除所有旧版本插件下载链接. 优化了一下字体颜色. 修复:当OP使用命令更改玩家密码后玩家将会被踢出服务器.需要重新登录.

0.40-Y-45PRE——新的安全机制:插件现在支持使用MD5加密玩家的密码. 使用过旧版本插件的腐竹需要在配置中开启Enable_SupportOldPassword

0.40-H-25RE——新的安全机制:拥有创造模式的玩家在登录前将被强制改为生存,登录后将会恢复. ; 当一位拥有创造模式的玩家进入服务器时没有注册,他的创造模式将会被永久取消. 修复一些OP命令执行时的显示错误.

0.40-Y-8RE——新特性:玩家未登录时将获得失明,玩家登录成功后将会有粒子效果.

0.40-L-RE——修复与某些NPC MOD或者NPC插件不兼容产生的问题.

0.40-F-RE——修复某些1.6.4服务端的兼容问题.现在可以完美兼容1.6.x服务端.

0.40-E-PR——新的安全机制 :当一位OP玩家进入服务器时没有注册,他的OP将会被永久取消.

0.40-B PR[正式版]——我们计划在这个版本进行插件重构,推翻并重写整个插件内部架构使其扩展性/维护性上升到一个新的高度,同时它的前置框架GeneralDataCore也进行了重构以便适应新的改动,重构后的FastLogin将会更稳定,更快速,更安全!

(这需要一段时间这也是这个插件近几个版本都没有添加新功能的原因之一 · 我们在为插件重构做准备)

0.40-A-PR[重要更新](开发预览版)——前置插件GeneralDataCore更新至V5(大幅提高GD文件查询效率),插件本体结构部分重制.便与开发维护. 修复几处BUG

0.37-B PR——地狱门检测优化,如果玩家登录时在地狱门中则将地狱门方块替换为空气,修改了一些语言文件字段名,使其更易辨认.

0.37-A-30-PR(开发预览版本)——修复"玩家登录保护"功能无效的BUG. 修正登录时在地狱门中导致的无法登录问题.将之前插件中的一些硬编码语言重新添加至语言文件！

0.37-A-RE(开发预览版本)——新特性:位置数据的存储将会更加精确,不会再丢失小数点,优化程序结构,大幅提高了数据库查询时的效率！配置文件再次改进.

0.36-F-30-RE——修复一处BUG:数据库连接会在无访问8小时后自动被断开.

0.36-F-15-RE——修复一处BUG:当玩家输入注册命令时不管有没有成功执行,他的IP都会被记录.

0.36-F-08-RE——[重要更新]:启用对GeneralDataCoreV4的支持(从此版本开始无法使用旧版GeneralDataCore),由于使用了gdcV4,FastLogin从这个版本开始支持使用Mysql进行存储数据！新特性——现在可以自定义玩家退出服务器的公告,插件配置文件现在的排版更好看.
0.36-G-26-RE——包含几十处细节修改.修改了一些配置文件字段名,使其更容易辨别.优化了插件结构.移除了注册线程中多余的调用方法.

(之前的配置文件里面没有大写字符是因为GeneralDataCore的早期版本不支持大写字符)

0.36-G-21——修复了一个重要BUG！务必更新.

0.36-G-15——修复影分身BUG,现在2名同名玩家同时在线则全部会被踢掉,新特性:插件升级版本后会自动备份旧版配置文件而不是每次都要重新配置.

0.36-D:新功能——现在可以自定义玩家进服与登录成功的公告(详细内容见配置文件).

0.36-B:更新版本支持,现在支持1.6.x到1.12.x的所有版本.

0.36-A:启用对新版本GeneralDataCoreV3.1的支持！(自此版本开始无法使用旧版的GeneralDataCore)因为早期版本的GDC在高负载下效率不足,这个缺陷在v3.1以后被修正。

0.35-C:尝试支持Sponge[放弃了]
0.35-B:新特性——机制更改,修复了当玩家未登录时移动视角会出现的"鬼畜" , 自此版本后当玩家进入服务器但未登录时在空中 FastLogin将允许玩家掉落至地面。修复了对部分Mod的兼容问题此外将允许使用自定义正则表达式对玩家名称进行判断.

0.35-A[重要更新]——前置插件GeneralDataCore更新至V3,废弃大量API,减少编码工作量以及扩展性与可维护性.

0.35[重要更新]——修复大量BUG,修复某些无效的功能,修复后台报错。

0.34-A:新特性——前置插件GeneralDataCore更新至V2,大量采用异步IO,使得插件的效率变得非常高！

0.34——修复已知BUG,每次开启服务器时配置文件会重置.

0.33——将插件80%的代码进行了重制,保证了今后的扩展性和可维护性。

*0.32[重要更新]——OP账号在登陆之前将不会是OP,优化性能,采用异步IO,在垃圾硬盘下的性能获得提升！

0.31-D:新特性——增加了对玩家IP的判断项(详细见配置文件介绍)

*0.3.1-C:新特性——增加了对玩家名称的判断项(详细见配置文件介绍),增加了1个命令,用于OP强制更改玩家密码。

*0.3.1-A:新特性——添加了一个可以修复卡位置的选项(需要先设置固定上线点,然后将配置文件中的locationprotection项改成true)

0.3.1R1:插件稳定性得到提升,优化了一些算法,修复某些指令执行不当造成的NPE。

0.3.1: 新特性 ——现在能够设置固定上线地点,还能自定义登录后的无敌时间, 修复某些情况下的报错. 优化效率.

0.3.0R6:可以设定玩家名称的最小长度,修复了注册和重载命令执行不当而造成的后台报错.
可以使用/reg和/l 来注册和登录

*0.3.0R5:彻底修复了在Linux系统下无法使用的情况。

0.3.0R4:修复了在Linux系统下玩家名大小写引起的BUG ,从此版本开始插件会将旧版本玩家数据文件升级为新版数据文件。

0.2.8:优化对Linux系统的支持但目前Linux下还是有BUG

0.2.6:修复大部分已知BUG 再次优化代码.减少资源占用.

0.2.3:增加玩家改密码功能

0.2.1:修复了玩家会被同ID登录而踢出的BUG

0.1.9:采用新的文件格式, 从此版本开始插件会将旧版配置文件自动升级为新版配置文件配置文件名称改为:FastLogin.conf

0.1.7:优化代码,减少占用。

*0.1.4:插件基本功能开发完成

Residence

2021-05-14T18:10:51Z

声名我主宰：

Residence是大多数服务器都会使用的插件，它不同于其他保护类插件，它可以让玩家自己保护自己的家园，无需再麻烦管理员。新版的Residence更是增添了许多新特性，为服主减轻了不少负担。

注：旧版本的Residence已不再支持1.8以上的Minecraft服务器，本页面仅适用于新版本。<blockquote></blockquote>
[[文件:Residence logo.jpg|有框|右]]
==特性==

* 领地选区可视化操作。选择领地区域时，会以粒子效果显示所选区域。（此特性仅支持1.8版本以上的服务器）
* 领地权限设置GUI操作。设置权限时，不必再逐条输入指令，只需打开GUI界面，即可轻松设置领地权限。
* 领地帮助列表可点击。帮助列表中的指令、翻页按钮都可以用鼠标直接点击，无需手动输入。（此特性仅支持1.8版本以上的服务器）
* 丰富的领地内聊天系统。服主可自行设置聊天前缀和颜色。
* 领地区域可扩展。当建筑面积扩大时，无需删除领地重新创建，可在原有领地基础上扩展。
* 领地租赁/出售系统。玩家可以自行出租/租借/出售/购买领地。
* 集成领地木牌系统。不必安装额外插件，便可以使用木牌轻松交易领地。
* 可设置当玩家一段时间不上线后自动删除其领地。
* 可在某个世界不使用领地插件。
* 可在全图随机传送。
* 支持多世界插件。

== 支持版本 ==
Residence插件支持'''1.7.10/1.8/1.9/1.10/1.11/1.12'''版本

完全支持'''Bukkit/Spigot/PaperSpigot'''服务端

==安装与配置==
===安装===
将下载的领地插件放入plugins文件夹，运行服务器以生成必要的文件。<br />保持默认的设置即可正常使用，无需手动添加权限，若要修改设置请参见下方的配置文件说明。
===配置文件说明===
注：配置文件的翻译工作进行中
====config.yml====
<syntaxhighlight lang="yaml">
Global:
# 语言设置，国人一般喜欢设为Chinese
Language: English
# 领地选区工具，默认是木棍（280）
SelectionToolId: 280
# 领地信息查看工具，默认是线（287）
InfoToolId: 287
# 玩家位置移动检测间隔，单位为毫秒
# 减小将加大服务器负担
# 增大会减慢对玩家错误移动反应的时间
MoveCheckInterval: 500
# 领地保存的周期，单位为分钟
SaveInterval: 10
# 当无法调用或没有使用Permissions插件时默认使用的组
DefaultGroup: default
# 是否启用领地租赁(Lease)系统
UseLeaseSystem: false
# 领地租赁系统的检测周期，单位为分钟
LeaseCheckInterval: 10
# 在玩家的钱充足时，自动续期租赁的领地；如果经济系统关闭，此设置项无效
LeaseAutoRenew: true
# 是否使用Permissions插件来管控领地的权限
EnablePermissions: true
# 若未使用 Permissions 或 PermissionsBukkit 插件，请设置为true
LegacyPermissions: false
# 开启/关闭领地经济系统 (支持iConomy, MineConomy, Essentials, BOSEconomy, RealEconomy).
EnableEconomy: true
# 是否开启领地租借(Rent)系统（关于Rent和上文Lease的区别，望了解者加以修改完善）
EnableRentSystem: false
# 领地租借到期时间的检测周期，单位为分钟
RentCheckInterval: 10
# 是否开启领地聊天频道
ResidenceChatEnable: true
# 是否使用ActionBar（低于1.8版本请设为false）
UseActionBar: true
# 领地聊天频道的字体颜色
ResidenceChatColor: DARK_PURPLE
# 是否只允许OP修改领地
AdminOnlyCommands: false
# 是否将OP设为领地插件的管理员
AdminOPs: true
# 填入服务器所使用的多世界插件（Multiverse-Core或Multiworld），若使用多世界插件，请务必填写！
MultiWorldPlugin: Multiverse-Core
# 是否让子领地继承领地的权限设置
ResidenceFlagsInherit: true
# 是否阻止领地的租借者修改领地的设置
PreventRentModify: true
# 是否在检测到领地文件出现错误时停止加载插件
StopOnSaveFault: true
# 允许的领地名字限制，使用正则表达式
ResidenceNameRegex: '[^a-zA-Z0-9\\-\\_]'
# 若设为true，则每当插件检测租赁（Lease）或租借（Rent）时便向控制台输出一条消息
ShowIntervalMessages: false
# 是否在服务器开启时检查插件版本
VersionCheck: true
# Experimental - The following settings are lists of block IDs to be used as part of the checks for the "container" and "use" flags when using mods.
CustomContainers: []
CustomBothClick: []
CustomRightClick: []

</syntaxhighlight>

====groups.yml====
<syntaxhighlight lang="yaml">
Groups:
Default: #组名，不要删除这个组
#删除下面的井号可将此配置应用到其他组
#Mirror:
#- 'group1'
#- 'group2'
Residence:
# 该组玩家是否可以创建领地
CanCreate: true
# 玩家可以拥有的最大领地数量
MaxResidences: 3
# 领地可包含的最大物理区域
MaxAreasPerResidence: 2
# 领地最大格数（东西方向）
MaxEastWest: 16
# 领地最小格数（东西方向），设为-1则不限制
MinEastWest: 3
# 领地最大格数（南北方向）
MaxNorthSouth: 16
# 领地最小格数（南北方向）
MinNorthSouth: 3
# 领地最大格数（高度）
MaxUpDown: 256
# 领地最小格数（高度），设为-1则不限制
MinUpDown: 3
# 可创建领地的最小高度
MinHeight: 0
# 可创建领地的最大高度
MaxHeight: 255
# 所在区域可拥有的最大子领地数量
MaxSubzonesInArea: 3
# 最大子领地深度
# 一个领地中的子领地中的子领地深度为2
# 设为0以禁用子领地
# 译者注：子领地深度即子领地嵌套的层数，子领地的子领地深度为2，以此类推
SubzoneDepth: 3
# （可选）子领地最大格数（东西方向）
SubzoneMaxEastWest: 16
# （可选）子领地最小格数（东西方向）
SubzoneMinEastWest: 3
# （可选）子领地最大格数（南北方向）
SubzoneMaxNorthSouth: 16
# （可选）子领地最小格数（南北方向）
SubzoneMinNorthSouth: 3
# （可选）子领地最大格数（高度）
SubzoneMaxUpDown: 256
# （可选）子领地最霄格数（高度）
SubzoneMinUpDown: 3
# 是否允许领地传送
CanTeleport: true
# 允许或禁止使用/ res unstuck使你在被困住的时候离开领地
Unstuck: true
# 允许或禁止使用/res kick把玩家从领地踢出
Kick: False
# 允许或禁止使用/res select命令，如果禁止则玩家只能使用圈地工具来选择选区
#译者注：建议禁用，原因见此：http://mineplugin.org/Residence#.E5.88.A9.E7.94.A8.2Fres_select_shift.E5.91.BD.E4.BB.A4.E5.B0.86.E9.A2.86.E5.9C.B0.E9.80.89.E5.8C.BA.E7.A7.BB.E8.87.B3.E6.97.A0.E9.99.90.E8.BF.9C.E5.AF.BC.E8.87.B4.E6.9C.8D.E5.8A.A1.E5.99.A8.E5.B4.A9.E6.BA.83
SelectCommandAccess: true
# Allow or Disallow the group to access the Blacklist/Ignorelist for residences they own.
ItemListAccess: true
# Options relating to enter and leave messages on the residence.
Messaging:
# Whether or not the player can change the Residence enter and leave messages.
CanChange: true
# The default enter message to apply to new Residences created by players in this group.
# Leaving the message blank will disable it.
DefaultEnter: Welcome %player to %residence, owned by %owner.
# The default leave message to apply to new Residences created by players in this group.
# Leaving the message blank will disable it.
DefaultLeave: Now leaving %residence.
# Options relating to the Lease system.
Lease:
# The maximum number of days to allow leases.
MaxDays: 16
# The number of days to add to the lease following a '/res lease renew' command.
RenewIncrement: 14
#Options related to the rent system
Rent:
#determines how many residences can be rented by players of this group at once
MaxRents: 3
#determines how many residences can be set for rent by players of this group at once
MaxRentables: 3
# determines max days player can rent residence at once
MaxRentDays: 31
# Options relating to the Residence Economy.
Economy:
# Whether or not players in this group can buy other Residences that are for sale.
CanBuy: true
# Whether or not players in this group can sell their Residences.
CanSell: false
# Whether or not to ignore the Residence size/count limits when buying a residence.
IgnoreLimits: false
# The cost, per block, of making a new Residence or adding a area to it.
BuyCost: 0.5
# The cost, per block, player will be getting back when removing residence.
SellCost: 0.25
# The cost, per block, of renewing a Residence lease (if the lease system is enabled).
RenewCost: 0.2
# Flags are checked in the order:
# 1: Player
# 2: Group
# 3: Owner
# 4: If all others are undefined, reverts to default value (usually true).
# Flag permissions default to false.
# These flags settings override the globals.
Flags:
# Specifically allow or deny this group from changing certain flags.
Permission:
#build: true
# Specifys the flags that are applied at residence creation for players of this group.
Default:
#build: true
# Specifys the flags that are applied at to the creator at residence creation.
CreatorDefault:
#build: true
# Specifys the flags that are applied to other groups for this residence, at creation.
GroupDefault:
#default: #group name
#build: false
#these flags are applied specifically to this group whenever they are outside a residence
#these flags will override the flags at the top, under the Global section.
World:
Global: #these flags will apply to all worlds
#build: false
WorldNameHere: #or you can apply them by each individual world
#build: false
NextGroup: #group name, player should have residence.group.nextgroup permission node to have access to this residence group
Residence:
CanCreate: true
MaxResidences: 4
MaxAreasPerResidence: 2
MaxEastWest: 20
MaxNorthSouth: 20
MaxUpDown: 20
MinHeight: 0
MaxHeight: 255
SubzoneDepth: 3
CanTeleport: true
Unstuck: true
Kick: true
SelectCommandAccess: true
ItemListAccess: true
Messaging:
CanChange: true
DefaultEnter: Welcome %player to %residence, owned by %owner.
DefaultLeave: Now leaving %residence.
Lease:
MaxDays: 16
RenewIncrement: 14
Rent:
MaxRents: 3
MaxRentables: 3
MaxRentDays: 31
Economy:
CanBuy: true
CanSell: false
IgnoreLimits: false
BuyCost: 0.7
SellCost: 0.3
RenewCost: 0.3

# You can manually specify the group a player is in below, this overrides their permissions group.
GroupAssignments:
bekvon: default
player: default
</syntaxhighlight>

====flags.yml====
<syntaxhighlight lang="yaml">
#These are Global Settings for Residence.
Global:
# These are world flags that are applied when the player is NOT within a residence.
Flags:
Global: #these are default for all worlds unless specified below, they can be overridden per group
use: true
build: true
ignite: true
firespread: true
damage: true
creeper: true
tnt: true
pvp: true
WorldNameHere: #here you can set flags for individual worlds, these override Global
#build: true
# This gives permission to change certain flags to all groups, unless specifically denied to the group.
FlagPermission:
move: true
build: true
place: true
destroy: true
use: true
container: true
pvp: true
tp: true
ignite: true
firespread: true
flow: true
lavaflow: true
waterflow: true
creeper: true
tnt: true
monsters: true
animals: true
animalkilling: true
mobkilling: true
vehicledestroy: true
trade: true
shear: true
leash: true
nofly: false
subzone: true
healing: true
piston: true
diode: true
lever: true
button: true
door: true
table: true
enchant: true
brew: true
bed: true
cake: true
note: true
trample: true
burn: true
explode: true
fireball: true
command: false
day: true
night: true
chat: true
hidden: false
overridepvp: false
keepinv: false
keepexp: false
shop: true
bank: false
# This sets GUI items to represent each flag, if not given, then gray wool will be used
FlagGui:
animalkilling:
Id: 365
Data: 0
animals:
Id: 383
Data: 90
bed:
Id: 355
Data: 0
brew:
Id: 379
Data: 0
build:
Id: 45
Data: 0
burn:
Id: 50
Data: 0
button:
Id: 143
Data: 0
cake:
Id: 354
Data: 0
canimals:
Id: 383
Data: 91
chat:
Id: 386
Data: 0
cmonsters:
Id: 383
Data: 50
command:
Id: 137
Data: 0
container:
Id: 342
Data: 0
creeper:
Id: 383
Data: 50
destroy:
Id: 121
Data: 0
diode:
Id: 356
Data: 0
door:
Id: 324
Data: 0
enchant:
Id: 116
Data: 0
explode:
Id: 407
Data: 0
fireball:
Id: 385
Data: 0
firespread:
Id: 377
Data: 0
flow:
Id: 111
Data: 0
healing:
Id: 373
Data: 0
ignite:
Id: 259
Data: 0
lavaflow:
Id: 327
Data: 0
leash:
Id: 420
Data: 0
lever:
Id: 69
Data: 0
mobkilling:
Id: 367
Data: 0
monsters:
Id: 52
Data: 0
move:
Id: 301
Data: 0
nanimals:
Id: 383
Data: 92
nmonsters:
Id: 383
Data: 51
nofly:
Id: 171
Data: 1
nomobs:
Id: 166
Data: 0
note:
Id: 25
Data: 0
piston:
Id: 33
Data: 0
place:
Id: 169
Data: 0
pvp:
Id: 268
Data: 0
sanimals:
Id: 383
Data: 101
shear:
Id: 359
Data: 0
smonsters:
Id: 383
Data: 54
subzone:
Id: 160
Data: 7
table:
Id: 58
Data: 0
tnt:
Id: 46
Data: 0
tp:
Id: 120
Data: 0
trade:
Id: 388
Data: 0
trample:
Id: 3
Data: 0
use:
Id: 70
Data: 0
vehicledestroy:
Id: 328
Data: 0
waterflow:
Id: 326
Data: 0
# These are default flags applied to all residences from any user group.
ResidenceDefault:
build: false
destroy: false
use: false
container: false
pvp: false
tnt: false
creeper: false
ignite: false
firespread: false
vehicledestroy: false
animalkilling: false
hook: false
shear: false
leash: false
pistonprotection: true
tp: true
explode: false
# These are default flags applied to the residence creator of any group.
CreatorDefault:
build: true
move: true
use: true
ignite: true
container: true
animalkilling: true
mobkilling: true
vehicledestroy: true
trade: true
shear: true
leash: true
# These are default group flags applied to a residence made by a user of any group.
GroupDefault:
#default: #group name
#build: true
# These are grouped flags, so when using /res pset nickname redstone true, player will get all flags in list, same when setting to false or removing them.
GroupedFlags:
redstone:
- note
- pressure
- lever
- button
- diode
craft:
- brew
- table
- enchant
trusted:
- use
- tp
- build
- container
- move
- leash
- animalkilling
- mobkilling
- shear
- chat
- beacon
fire:
- ignite
- firespread
ItemList: #this is where you can create blacklists / whitelists
DefaultList: #list name is not important, as long as it is unique. Its good to use a descripive name.
#type of the list, can be blacklist, whitelist, or ignorelist
Type: blacklist
#If you want, you can have this list only apply to one world, otherwise it applys to all worlds
#World: world
#You can also have the list apply only to one group, otherwise it applys for all groups
#Group: default
#this is the actual list of material names that this list allows or dissallows
#You can look up the material name by item ID in game by typing /res material <id>
#Alternativly, you can simply use the item ID in the list, but its less descriptive and harder to see what the list allows or dissallows at a glance
Items:
- 'BEDROCK'
- 'LAVA'
- 'WATER'
- 'STATIONARY_LAVA'
- 'STATIONARY_WATER'
- 'MOB_SPAWNER'
</syntaxhighlight>

===插件权限===
{| class="wikitable"
|-
! 权限 !! 介绍 !! 默认使用者
|-
| residence.group.[groupname] || 从groups.yml中设置玩家的领地组 ||
|-
| residence.flag.[flag] || 在某flag在flag.yml中关闭时允许玩家使用该flag ||
|-
| residence.worldguard.[worldRegionName] || 允许在worldguard区域内创建领地 ||
|-
| residence.max.subzones.[number] || 玩家可拥有的最大子领地数量 ||
|-
| residence.max.rents.[number] || 玩家可出租的最大领地数量 ||
|-
| residence.max.res.[number] || 玩家可拥有的最大领地数量 ||
|-
| residence.admin || 给玩家使用/resadmin的权限 || OP
|-
| residence.topadmin || 给玩家使用 /resreload 和 /resload commands的权限 || OP
|-
| residence.admin.tp || 允许无视tp权限 || OP
|-
| residence.admin.move || 允许无视移动权限 || OP
|-
| residence.create || 允许创建领地 || Default
|-
| residence.select || 允许选择区域以创建领地 || Default
|-
| residence.nofly.bypass || 无视禁飞 || OP
|-
| residence.delete || 允许删除自己的领地 || Default
|-
| residence.delete.subzone || 允许删除自己的子领地 || Default
|-
| residence.rename || 允许重命名领地 || Default
|-
| residence.create.subzone || 允许在领地内创建子领地 || Default
|-
| residence.expand || 允许扩张自己的领地 || Default
|-
| residence.expand.subzone || 允许扩张自己的子领地 || Default
|-
| residence.contract || 允许合并自己的领地 || Default
|-
| residence.contract.subzone || 允许合并自己的子领地 || Default
|-
| residence.resize || 允许重新设置领地大小 || Default
|-
| residence.versioncheck || 允许接收新版本通知 || OP
|-
| residence.flag.command.bypass || 无视领地内输入命令权限 || OP
|-
| residence.select.auto.others || 允许为其他玩家开启自动选择 || OP
|-
| residence.chatcolor || 允许修改领地聊天颜色 || Default
|-
| residence.chatprefix || 允许修改领地聊天前缀 || OP
|-
| residence.chatkick || 允许将玩家从领地聊天频道踢出 || Default
|-
| residence.compass || 允许设置指南针指向 || Default
|-
| residence.randomtp || 允许使用 /res rt 命令 || Default
|-
| residence.bypass.build || 无视 build false flag ||
|-
| residence.bypass.destroy || 无视 destroy false flag ||
|-
| residence.bypass.ignorey || 无视领地Y坐标（高度）限制 ||
|-
| residence.backup || 允许使用flag：backup ||
|-
| residence.cleanbypass || 防止玩家的领地在自动清理时被移除 ||
|-
| residence.market.evict || 允许强制赶出领地内的玩家 ||
|-
| residence.flybypass || 允许无视禁止飞行设置 ||
|-
|}

==注意事项==
# 若使用Vault和WorldEdit，建议使用最新版本，否则可能出现各种问题。
# 若使用多世界插件（Multiverse-Core或Multiworld），必须在config.yml的“MultiWorldPlugin:”后填写（如：MultiWorldPlugin: Multiverse-Core），否则会出现重启服务器领地不保存的问题。
# 1.8版本以下不支持ActionBar功能，插件默认开启此功能，可在config.yml中设置关闭（UseActionBar: false）
==插件获取==
:此插件为SpigotMC上的付费插件，价格为9.99欧元（约合76.4RMB），作者在SpigotMC的页面中放出了不需付费的下载链接，可自行前去寻找。（[https://www.spigotmc.org/resources/residence-1-7-10-up-to-1-12.11480/ 点击前往]）
:欲及时获知新版本及新版特性，可去mcbbs.net服务器插件区搜索“Residence”收藏搬运帖。

== 已知Bug及应对方案 ==

=== 利用/res select shift命令将领地选区移至无限远导致服务器崩溃 ===
Bug描述：选择领地区域时，利用/res select shift指令，可将领地选区移动到无限远的地方（甚至超越地图边界），然后创建领地，严重可导致服务器瞬间崩溃。

应对方案：

方案一：在groups.yml中，将SelectCommandAccess设为false，则玩家只能通过选取工具来选取领地，而无法使用/res select指令

方案二：若装有essentials或其他权限管理插件，可为玩家组添加-residence.command.select权限，禁止玩家使用/res select指令

Residence

2021-05-14T18:08:09Z

声名我主宰：/* 插件权限 */ 更改格式

Residence是大多数服务器都会使用的插件，它不同于其他保护类插件，它可以让玩家自己保护自己的家园，无需再麻烦管理员。新版的Residence更是增添了许多新特性，为服主减轻了不少负担。

注：旧版本的Residence已不再支持1.8以上的Minecraft服务器，本页面仅适用于新版本。<blockquote></blockquote>
[[文件:Residence logo.jpg|有框|右]]
==特性==

* 领地选区可视化操作。选择领地区域时，会以粒子效果显示所选区域。（此特性仅支持1.8版本以上的服务器）
* 领地权限设置GUI操作。设置权限时，不必再逐条输入指令，只需打开GUI界面，即可轻松设置领地权限。
* 领地帮助列表可点击。帮助列表中的指令、翻页按钮都可以用鼠标直接点击，无需手动输入。（此特性仅支持1.8版本以上的服务器）
* 丰富的领地内聊天系统。服主可自行设置聊天前缀和颜色。
* 领地区域可扩展。当建筑面积扩大时，无需删除领地重新创建，可在原有领地基础上扩展。
* 领地租赁/出售系统。玩家可以自行出租/租借/出售/购买领地。
* 集成领地木牌系统。不必安装额外插件，便可以使用木牌轻松交易领地。
* 可设置当玩家一段时间不上线后自动删除其领地。
* 可在某个世界不使用领地插件。
* 可在全图随机传送。
* 支持多世界插件。

== 支持版本 ==
Residence插件支持'''1.7.10/1.8/1.9/1.10/1.11/1.12'''版本

完全支持'''Bukkit/Spigot/PaperSpigot'''服务端

==安装与配置==
===安装===
将下载的领地插件放入plugins文件夹，运行服务器以生成必要的文件。<br />保持默认的设置即可正常使用，无需手动添加权限，若要修改设置请参见下方的配置文件说明。
===配置文件说明===
注：配置文件的翻译工作进行中
====config.yml====
<syntaxhighlight lang="yaml">
Global:
# 语言设置，国人一般喜欢设为Chinese
Language: English
# 领地选区工具，默认是木棍（280）
SelectionToolId: 280
# 领地信息查看工具，默认是线（287）
InfoToolId: 287
# 玩家位置移动检测间隔，单位为毫秒
# 减小将加大服务器负担
# 增大会减慢对玩家错误移动反应的时间
MoveCheckInterval: 500
# 领地保存的周期，单位为分钟
SaveInterval: 10
# 当无法调用或没有使用Permissions插件时默认使用的组
DefaultGroup: default
# 是否启用领地租赁(Lease)系统
UseLeaseSystem: false
# 领地租赁系统的检测周期，单位为分钟
LeaseCheckInterval: 10
# 在玩家的钱充足时，自动续期租赁的领地；如果经济系统关闭，此设置项无效
LeaseAutoRenew: true
# 是否使用Permissions插件来管控领地的权限
EnablePermissions: true
# 若未使用 Permissions 或 PermissionsBukkit 插件，请设置为true
LegacyPermissions: false
# 开启/关闭领地经济系统 (支持iConomy, MineConomy, Essentials, BOSEconomy, RealEconomy).
EnableEconomy: true
# 是否开启领地租借(Rent)系统（关于Rent和上文Lease的区别，望了解者加以修改完善）
EnableRentSystem: false
# 领地租借到期时间的检测周期，单位为分钟
RentCheckInterval: 10
# 是否开启领地聊天频道
ResidenceChatEnable: true
# 是否使用ActionBar（低于1.8版本请设为false）
UseActionBar: true
# 领地聊天频道的字体颜色
ResidenceChatColor: DARK_PURPLE
# 是否只允许OP修改领地
AdminOnlyCommands: false
# 是否将OP设为领地插件的管理员
AdminOPs: true
# 填入服务器所使用的多世界插件（Multiverse-Core或Multiworld），若使用多世界插件，请务必填写！
MultiWorldPlugin: Multiverse-Core
# 是否让子领地继承领地的权限设置
ResidenceFlagsInherit: true
# 是否阻止领地的租借者修改领地的设置
PreventRentModify: true
# 是否在检测到领地文件出现错误时停止加载插件
StopOnSaveFault: true
# 允许的领地名字限制，使用正则表达式
ResidenceNameRegex: '[^a-zA-Z0-9\\-\\_]'
# 若设为true，则每当插件检测租赁（Lease）或租借（Rent）时便向控制台输出一条消息
ShowIntervalMessages: false
# 是否在服务器开启时检查插件版本
VersionCheck: true
# Experimental - The following settings are lists of block IDs to be used as part of the checks for the "container" and "use" flags when using mods.
CustomContainers: []
CustomBothClick: []
CustomRightClick: []

</syntaxhighlight>

====groups.yml====
<syntaxhighlight lang="yaml">
Groups:
Default: #组名，不要删除这个组
#删除下面的井号可将此配置应用到其他组
#Mirror:
#- 'group1'
#- 'group2'
Residence:
# 该组玩家是否可以创建领地
CanCreate: true
# 玩家可以拥有的最大领地数量
MaxResidences: 3
# 领地可包含的最大物理区域
MaxAreasPerResidence: 2
# 领地最大格数（东西方向）
MaxEastWest: 16
# 领地最小格数（东西方向），设为-1则不限制
MinEastWest: 3
# 领地最大格数（南北方向）
MaxNorthSouth: 16
# 领地最小格数（南北方向）
MinNorthSouth: 3
# 领地最大格数（高度）
MaxUpDown: 256
# 领地最小格数（高度），设为-1则不限制
MinUpDown: 3
# 可创建领地的最小高度
MinHeight: 0
# 可创建领地的最大高度
MaxHeight: 255
# 所在区域可拥有的最大子领地数量
MaxSubzonesInArea: 3
# 最大子领地深度
# 一个领地中的子领地中的子领地深度为2
# 设为0以禁用子领地
# 译者注：子领地深度即子领地嵌套的层数，子领地的子领地深度为2，以此类推
SubzoneDepth: 3
# （可选）子领地最大格数（东西方向）
SubzoneMaxEastWest: 16
# （可选）子领地最小格数（东西方向）
SubzoneMinEastWest: 3
# （可选）子领地最大格数（南北方向）
SubzoneMaxNorthSouth: 16
# （可选）子领地最小格数（南北方向）
SubzoneMinNorthSouth: 3
# （可选）子领地最大格数（高度）
SubzoneMaxUpDown: 256
# （可选）子领地最霄格数（高度）
SubzoneMinUpDown: 3
# 是否允许领地传送
CanTeleport: true
# 允许或禁止使用/ res unstuck使你在被困住的时候离开领地
Unstuck: true
# 允许或禁止使用/res kick把玩家从领地踢出
Kick: False
# 允许或禁止使用/res select命令，如果禁止则玩家只能使用圈地工具来选择选区
#译者注：建议禁用，原因见此：http://mineplugin.org/Residence#.E5.88.A9.E7.94.A8.2Fres_select_shift.E5.91.BD.E4.BB.A4.E5.B0.86.E9.A2.86.E5.9C.B0.E9.80.89.E5.8C.BA.E7.A7.BB.E8.87.B3.E6.97.A0.E9.99.90.E8.BF.9C.E5.AF.BC.E8.87.B4.E6.9C.8D.E5.8A.A1.E5.99.A8.E5.B4.A9.E6.BA.83
SelectCommandAccess: true
# Allow or Disallow the group to access the Blacklist/Ignorelist for residences they own.
ItemListAccess: true
# Options relating to enter and leave messages on the residence.
Messaging:
# Whether or not the player can change the Residence enter and leave messages.
CanChange: true
# The default enter message to apply to new Residences created by players in this group.
# Leaving the message blank will disable it.
DefaultEnter: Welcome %player to %residence, owned by %owner.
# The default leave message to apply to new Residences created by players in this group.
# Leaving the message blank will disable it.
DefaultLeave: Now leaving %residence.
# Options relating to the Lease system.
Lease:
# The maximum number of days to allow leases.
MaxDays: 16
# The number of days to add to the lease following a '/res lease renew' command.
RenewIncrement: 14
#Options related to the rent system
Rent:
#determines how many residences can be rented by players of this group at once
MaxRents: 3
#determines how many residences can be set for rent by players of this group at once
MaxRentables: 3
# determines max days player can rent residence at once
MaxRentDays: 31
# Options relating to the Residence Economy.
Economy:
# Whether or not players in this group can buy other Residences that are for sale.
CanBuy: true
# Whether or not players in this group can sell their Residences.
CanSell: false
# Whether or not to ignore the Residence size/count limits when buying a residence.
IgnoreLimits: false
# The cost, per block, of making a new Residence or adding a area to it.
BuyCost: 0.5
# The cost, per block, player will be getting back when removing residence.
SellCost: 0.25
# The cost, per block, of renewing a Residence lease (if the lease system is enabled).
RenewCost: 0.2
# Flags are checked in the order:
# 1: Player
# 2: Group
# 3: Owner
# 4: If all others are undefined, reverts to default value (usually true).
# Flag permissions default to false.
# These flags settings override the globals.
Flags:
# Specifically allow or deny this group from changing certain flags.
Permission:
#build: true
# Specifys the flags that are applied at residence creation for players of this group.
Default:
#build: true
# Specifys the flags that are applied at to the creator at residence creation.
CreatorDefault:
#build: true
# Specifys the flags that are applied to other groups for this residence, at creation.
GroupDefault:
#default: #group name
#build: false
#these flags are applied specifically to this group whenever they are outside a residence
#these flags will override the flags at the top, under the Global section.
World:
Global: #these flags will apply to all worlds
#build: false
WorldNameHere: #or you can apply them by each individual world
#build: false
NextGroup: #group name, player should have residence.group.nextgroup permission node to have access to this residence group
Residence:
CanCreate: true
MaxResidences: 4
MaxAreasPerResidence: 2
MaxEastWest: 20
MaxNorthSouth: 20
MaxUpDown: 20
MinHeight: 0
MaxHeight: 255
SubzoneDepth: 3
CanTeleport: true
Unstuck: true
Kick: true
SelectCommandAccess: true
ItemListAccess: true
Messaging:
CanChange: true
DefaultEnter: Welcome %player to %residence, owned by %owner.
DefaultLeave: Now leaving %residence.
Lease:
MaxDays: 16
RenewIncrement: 14
Rent:
MaxRents: 3
MaxRentables: 3
MaxRentDays: 31
Economy:
CanBuy: true
CanSell: false
IgnoreLimits: false
BuyCost: 0.7
SellCost: 0.3
RenewCost: 0.3

# You can manually specify the group a player is in below, this overrides their permissions group.
GroupAssignments:
bekvon: default
player: default
</syntaxhighlight>

====flags.yml====
<syntaxhighlight lang="yaml">
#These are Global Settings for Residence.
Global:
# These are world flags that are applied when the player is NOT within a residence.
Flags:
Global: #these are default for all worlds unless specified below, they can be overridden per group
use: true
build: true
ignite: true
firespread: true
damage: true
creeper: true
tnt: true
pvp: true
WorldNameHere: #here you can set flags for individual worlds, these override Global
#build: true
# This gives permission to change certain flags to all groups, unless specifically denied to the group.
FlagPermission:
move: true
build: true
place: true
destroy: true
use: true
container: true
pvp: true
tp: true
ignite: true
firespread: true
flow: true
lavaflow: true
waterflow: true
creeper: true
tnt: true
monsters: true
animals: true
animalkilling: true
mobkilling: true
vehicledestroy: true
trade: true
shear: true
leash: true
nofly: false
subzone: true
healing: true
piston: true
diode: true
lever: true
button: true
door: true
table: true
enchant: true
brew: true
bed: true
cake: true
note: true
trample: true
burn: true
explode: true
fireball: true
command: false
day: true
night: true
chat: true
hidden: false
overridepvp: false
keepinv: false
keepexp: false
shop: true
bank: false
# This sets GUI items to represent each flag, if not given, then gray wool will be used
FlagGui:
animalkilling:
Id: 365
Data: 0
animals:
Id: 383
Data: 90
bed:
Id: 355
Data: 0
brew:
Id: 379
Data: 0
build:
Id: 45
Data: 0
burn:
Id: 50
Data: 0
button:
Id: 143
Data: 0
cake:
Id: 354
Data: 0
canimals:
Id: 383
Data: 91
chat:
Id: 386
Data: 0
cmonsters:
Id: 383
Data: 50
command:
Id: 137
Data: 0
container:
Id: 342
Data: 0
creeper:
Id: 383
Data: 50
destroy:
Id: 121
Data: 0
diode:
Id: 356
Data: 0
door:
Id: 324
Data: 0
enchant:
Id: 116
Data: 0
explode:
Id: 407
Data: 0
fireball:
Id: 385
Data: 0
firespread:
Id: 377
Data: 0
flow:
Id: 111
Data: 0
healing:
Id: 373
Data: 0
ignite:
Id: 259
Data: 0
lavaflow:
Id: 327
Data: 0
leash:
Id: 420
Data: 0
lever:
Id: 69
Data: 0
mobkilling:
Id: 367
Data: 0
monsters:
Id: 52
Data: 0
move:
Id: 301
Data: 0
nanimals:
Id: 383
Data: 92
nmonsters:
Id: 383
Data: 51
nofly:
Id: 171
Data: 1
nomobs:
Id: 166
Data: 0
note:
Id: 25
Data: 0
piston:
Id: 33
Data: 0
place:
Id: 169
Data: 0
pvp:
Id: 268
Data: 0
sanimals:
Id: 383
Data: 101
shear:
Id: 359
Data: 0
smonsters:
Id: 383
Data: 54
subzone:
Id: 160
Data: 7
table:
Id: 58
Data: 0
tnt:
Id: 46
Data: 0
tp:
Id: 120
Data: 0
trade:
Id: 388
Data: 0
trample:
Id: 3
Data: 0
use:
Id: 70
Data: 0
vehicledestroy:
Id: 328
Data: 0
waterflow:
Id: 326
Data: 0
# These are default flags applied to all residences from any user group.
ResidenceDefault:
build: false
destroy: false
use: false
container: false
pvp: false
tnt: false
creeper: false
ignite: false
firespread: false
vehicledestroy: false
animalkilling: false
hook: false
shear: false
leash: false
pistonprotection: true
tp: true
explode: false
# These are default flags applied to the residence creator of any group.
CreatorDefault:
build: true
move: true
use: true
ignite: true
container: true
animalkilling: true
mobkilling: true
vehicledestroy: true
trade: true
shear: true
leash: true
# These are default group flags applied to a residence made by a user of any group.
GroupDefault:
#default: #group name
#build: true
# These are grouped flags, so when using /res pset nickname redstone true, player will get all flags in list, same when setting to false or removing them.
GroupedFlags:
redstone:
- note
- pressure
- lever
- button
- diode
craft:
- brew
- table
- enchant
trusted:
- use
- tp
- build
- container
- move
- leash
- animalkilling
- mobkilling
- shear
- chat
- beacon
fire:
- ignite
- firespread
ItemList: #this is where you can create blacklists / whitelists
DefaultList: #list name is not important, as long as it is unique. Its good to use a descripive name.
#type of the list, can be blacklist, whitelist, or ignorelist
Type: blacklist
#If you want, you can have this list only apply to one world, otherwise it applys to all worlds
#World: world
#You can also have the list apply only to one group, otherwise it applys for all groups
#Group: default
#this is the actual list of material names that this list allows or dissallows
#You can look up the material name by item ID in game by typing /res material <id>
#Alternativly, you can simply use the item ID in the list, but its less descriptive and harder to see what the list allows or dissallows at a glance
Items:
- 'BEDROCK'
- 'LAVA'
- 'WATER'
- 'STATIONARY_LAVA'
- 'STATIONARY_WATER'
- 'MOB_SPAWNER'
</syntaxhighlight>

{| class="wikitable"
|-
! 权限 !! 介绍 !! 默认使用者
|-
| residence.group.[groupname] || 从groups.yml中设置玩家的领地组 ||
|-
| residence.flag.[flag] || 在某flag在flag.yml中关闭时允许玩家使用该flag ||
|-
| residence.worldguard.[worldRegionName] || 允许在worldguard区域内创建领地 ||
|-
| residence.max.subzones.[number] || 玩家可拥有的最大子领地数量 ||
|-
| residence.max.rents.[number] || 玩家可出租的最大领地数量 ||
|-
| residence.max.res.[number] || 玩家可拥有的最大领地数量 ||
|-
| residence.admin || 给玩家使用/resadmin的权限 || OP
|-
| residence.topadmin || 给玩家使用 /resreload 和 /resload commands的权限 || OP
|-
| residence.admin.tp || 允许无视tp权限 || OP
|-
| residence.admin.move || 允许无视移动权限 || OP
|-
| residence.create || 允许创建领地 || Default
|-
| residence.select || 允许选择区域以创建领地 || Default
|-
| residence.nofly.bypass || 无视禁飞 || OP
|-
| residence.delete || 允许删除自己的领地 || Default
|-
| residence.delete.subzone || 允许删除自己的子领地 || Default
|-
| residence.rename || 允许重命名领地 || Default
|-
| residence.create.subzone || 允许在领地内创建子领地 || Default
|-
| residence.expand || 允许扩张自己的领地 || Default
|-
| residence.expand.subzone || 允许扩张自己的子领地 || Default
|-
| residence.contract || 允许合并自己的领地 || Default
|-
| residence.contract.subzone || 允许合并自己的子领地 || Default
|-
| residence.resize || 允许重新设置领地大小 || Default
|-
| residence.versioncheck || 允许接收新版本通知 || OP
|-
| residence.flag.command.bypass || 无视领地内输入命令权限 || OP
|-
| residence.select.auto.others || 允许为其他玩家开启自动选择 || OP
|-
| residence.chatcolor || 允许修改领地聊天颜色 || Default
|-
| residence.chatprefix || 允许修改领地聊天前缀 || OP
|-
| residence.chatkick || 允许将玩家从领地聊天频道踢出 || Default
|-
| residence.compass || 允许设置指南针指向 || Default
|-
| residence.randomtp || 允许使用 /res rt 命令 || Default
|-
| residence.bypass.build || 无视 build false flag ||
|-
| residence.bypass.destroy || 无视 destroy false flag ||
|-
| residence.bypass.ignorey || 无视领地Y坐标（高度）限制 ||
|-
| residence.backup || 允许使用flag：backup ||
|-
| residence.cleanbypass || 防止玩家的领地在自动清理时被移除 ||
|-
| residence.market.evict || 允许强制赶出领地内的玩家 ||
|-
| residence.flybypass || 允许无视禁止飞行设置 ||
|-
|}

==注意事项==
# 若使用Vault和WorldEdit，建议使用最新版本，否则可能出现各种问题。
# 若使用多世界插件（Multiverse-Core或Multiworld），必须在config.yml的“MultiWorldPlugin:”后填写（如：MultiWorldPlugin: Multiverse-Core），否则会出现重启服务器领地不保存的问题。
# 1.8版本以下不支持ActionBar功能，插件默认开启此功能，可在config.yml中设置关闭（UseActionBar: false）
==插件获取==
:此插件为SpigotMC上的付费插件，价格为9.99欧元（约合76.4RMB），作者在SpigotMC的页面中放出了不需付费的下载链接，可自行前去寻找。（[https://www.spigotmc.org/resources/residence-1-7-10-up-to-1-12.11480/ 点击前往]）
:欲及时获知新版本及新版特性，可去mcbbs.net服务器插件区搜索“Residence”收藏搬运帖。

== 已知Bug及应对方案 ==

=== 利用/res select shift命令将领地选区移至无限远导致服务器崩溃 ===
Bug描述：选择领地区域时，利用/res select shift指令，可将领地选区移动到无限远的地方（甚至超越地图边界），然后创建领地，严重可导致服务器瞬间崩溃。

应对方案：

方案一：在groups.yml中，将SelectCommandAccess设为false，则玩家只能通过选取工具来选取领地，而无法使用/res select指令

方案二：若装有essentials或其他权限管理插件，可为玩家组添加-residence.command.select权限，禁止玩家使用/res select指令