Residence

Residence

外文名	Residence
作者	Bekvon, t00thpick1, DartCZ 及更多
插件类型	Spigot / CraftBukkit
最新版本	5.1.2.0
兼容服务端	1.7.10 - 1.20.1
前置插件	CMILib
源地址	https://www.spigotmc.org/resources/residence-1-7-10-up-to-1-16.11480/

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

注：自5.0.0.0开始需要安装CMILib前置插件

旧版本的Residence不支持1.8以上的Minecraft服务器，本页面仅适用于新版本。

特性

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

安装与配置

安装

将下载的领地插件放入plugins文件夹，运行服务器以生成必要的文件。
保持默认的设置即可正常使用，无需手动添加权限，若要修改设置请参见下方的配置文件说明。

配置文件说明

config.yml

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
    # 是否只允许服务器管理员修改领地
    AdminOnlyCommands: false
    # 是否将服务器管理员设为领地插件的管理员
    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
    # 实验性功能 - 下列方块列表用于自定义检查"container"和"use"属性的方块ID（一般用于模组服务器）
    CustomContainers: []
    CustomBothClick: []
    CustomRightClick: []

groups.yml

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
           # 是否允许该组玩家访问自己领地的物品黑名单/忽略名单
           ItemListAccess: true
       # 以下为进出领地时的提示消息设置项
       Messaging:
           # 是否允许玩家更改进出领地时的提示消息
           CanChange: true
           # 此组玩家创建领地时默认的进入领地提示消息
           # 留空此项以禁用
           DefaultEnter: Welcome %player to %residence, owned by %owner.
           # 此组玩家创建领地时默认的离开领地提示消息
           # 留空此项以禁用
           DefaultLeave: Now leaving %residence.
       # 以下为出租系统设置项
       Lease:
          # 最多允许出租的天数
          MaxDays: 16
          # 当使用 '/res lease renew' 指令时续期的天数
          RenewIncrement: 14
       # 以下为租赁系统设置项
       Rent:
           # 此组玩家一次最多可租赁的领地数
           MaxRents: 3
           # 此组玩家一次最多可出租的领地数
           MaxRentables: 3
           # 此组玩家可出租领地的最长天数
           MaxRentDays: 31
       # 以下为领地经济系统设置项
       Economy:
          # 是否允许此组玩家购买其他玩家出售的领地
          CanBuy: true
          # 是否允许此组玩家出售领地
          CanSell: false
          # 是否在玩家购买领地时忽略领地大小/数量
          IgnoreLimits: false
          # 创建/扩大领地时每方块的价格
          BuyCost: 0.5
          # 删除领地时每方块返还的价格
          SellCost: 0.25
          # 续租领地时每方块的价格（如果启用了租赁系统的话）
          RenewCost: 0.2
       # 标记按顺序识别:
       # 1: 玩家
       # 2: 组
       # 3: 所有者
       # 4: 如果其它项均未定义，则使用默认值（通常为true）
       # 标记权限默认为false
       # 以下标记设置优先级高于全局设置
       Flags:
          # 指定此组玩家是否可以更改某些标记
          Permission:
               #build: true
          # 指定领地创建时对此组玩家默认应用的标记
          Default:
              #build: true
          # 指定领地创建时对创建者默认应用的标记
          CreatorDefault:
              #build: true
          # 指定领地创建时对其他组玩家默认应用的标记
          GroupDefault:
               #default: #组名
                   #build: false
          # 当处于领地外时，这些标记会被立即应用于此组玩家
          # 除了全局设置之外，这些标记的优先级最高
          World:
                Global: #以下标记会被应用于所有世界
                     #build: false
                WorldNameHere: #你也可以为每个世界分别设置
                     #build: false
    NextGroup: #组名，玩家必须拥有residence.group.nextgroup权限节点才能使用此组权限
       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

# 你可以在这里手动为玩家指定Ta所属的组，此项优先级高于权限组
GroupAssignments:
     bekvon: default
     player: default

flags.yml

# 以下为领地插件全局设置
Global:
    # 以下为领地外应用的世界标记
    Flags:
        Global: # 全局设置，除非在下面定义，否则全部为默认设置（可在组设置内覆盖）
            use: true
            build: true
            ignite: true
            firespread: true
            damage: true
            creeper: true
            tnt: true
            pvp: true
        WorldNameHere: # 你可以在这里为每个世界分别配置标记，优先级高于全局设置
            #build: true
    # 以下配置给予所有组更改标记的权限，除非为某个组单独配置
    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
    # 以下设置定义了在可视化界面中每个标记显示的物品样式，未定义则使用灰色羊毛
    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
    # 以下为默认应用至所有组的领地标记
    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
    # 以下为默认应用至创建者的领地标记
    CreatorDefault:
        build: true
        move: true
        use: true
        ignite: true
        container: true
        animalkilling: true
        mobkilling: true
        vehicledestroy: true
        trade: true
        shear: true
        leash: true
     # 以下为组内玩家创建领地时默认应用至此组的领地标记
    GroupDefault:
        #default: # 组名
            #build: true
     # 以下为组标记，当玩家使用 /res pset 昵称 redstone true时，玩家会得到列表内的标记，设置为false亦然
    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: # 在这里你可以创建黑名单/白名单
     DefaultList: # 列表名不重要，只要它是独一无二的，当然具有辨识性的名称更好 
        # 列表类型，可为blacklist，whitelist或ignorelist
        Type: blacklist
        # 可以根据需要将列表应用于特定世界或所有世界
        #World: world
        # 可以根据需要将列表应用于特定组或所有组
        #Group: default
        # 这是允许/禁止的物品具体名称列表
        # 你可以使用/res material <id>来查询对应的物品具体名称
        # 相对的，你也可以使用数字ID，但这样不方便辨别你到底允许/禁止了些什么
        Items: 
           - 'BEDROCK'
           - 'LAVA'
           - 'WATER'
           - 'STATIONARY_LAVA'
           - 'STATIONARY_WATER'
           - 'MOB_SPAWNER'

插件权限

权限	介绍	默认使用者
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	允许无视禁止飞行设置

注意事项

1. 若使用Vault和WorldEdit，建议使用最新版本，否则可能出现各种问题。
2. 若使用多世界插件（Multiverse-Core或Multiworld），必须在config.yml的“MultiWorldPlugin:”后填写（如：MultiWorldPlugin: Multiverse-Core），否则会出现重启服务器领地不保存的问题。
3. 1.8版本以下不支持ActionBar功能，插件默认开启此功能，可在config.yml中设置关闭（UseActionBar: false）

插件获取

此插件为SpigotMC上的付费插件，价格为9.99欧元（约合76.4RMB），作者在SpigotMC的页面中放出了不需付费的下载链接，可自行前去寻找。（点击前往）

欲及时获知新版本及新版特性，可去mcbbs.net服务器插件区搜索“Residence”收藏搬运帖。

已知Bug及应对方案

利用/res select shift命令将领地选区移至无限远导致服务器崩溃

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

应对方案：

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

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