Inactivity reset & Takeover

Inactivity reset & Takeover are two features that allow server admins to control what should happen with regions where the owner active on the server.

• Inactivity reset: Resets a region after the owner didn't log in into the server for a defined amount of time.
• Takeover: Allows active members of regions where the owner wasn't active for a defined amount of time to become the new owner of the region. This feature usually gets used in combination with the Inactivity reset-feature. Usually both features get configured in a way which allows members of regions with inactive owners to become the new owner, before the server would reset the region and therefore giving the members of the region a change to prevent the reset of the region. When a region is available for Takeover, members of that region will automatically get a popup in form of menu shortly after they've logged onto the server.

Both features get configured together in the config.yml. The default configuration looks like this:

InactivityExpiration:
  examplegroup1:
    resetAfter: 30d
    takeOverAfter: 20d
  examplegroup2:
    resetAfter: 60d
    takeOverAfter: 50d
  examplegroup3:
    resetAfter: none
    takeOverAfter: none

DefaultInactivityExpiration:
  resetAfter: none
  takeOverAfter: none

The configuration above contains 4 so called InactivityExpiration-groups. These are the default-group that you find in the section DefaultInactivityExpiration, that is applied to all players on the server that didn't got a different InactivityExpiration-group assigned. The other 3 groups are located in the configuration section InactivityExpiration. These are examplegroup1, examplegroup2 and examplegroup3. Groups can be added and removed by adding or removing configuration sections in form of the already existing group-sections from the InactivityExpiration-configuration section.

There are the following parameter:

• resetAfter: Specifies how long the region owner must be inactive in order to let the plugin reset his regions.
• takeOverAfter: Specifies how long the region owner must be inactive for the plugin to allow other members of his region to take over his regions and become the new owner of the region.

Depending on the permissions a players get assigned to the default-group or to some of the groups defined above. Players only get assigned to the DefaultInactivityExpiration-group if they didn't got assigned to a different group. Players can be assigned to one or more InactivityExpiration-groups, by giving them the permission arm.inactivityexpiration.<InactivityExpiration>. For example, the permission arm.inactivityexpiration.examplegroup1 would add a player to the first group from the section above.

When a player is part of multiple groups the plugin will merge all groups together, such that the player gets the most generous limits possible for him. But again: The default-group is only used as a fallback. If won't be taken into account if a player is part of any other InactivityExpiration-group.

The timer can be completely disabled for a player, by giving him the permission arm.inactivityexpiration.unlimited. It is also possible to manually set a timer to unlimited by setting the resetAfter or the takeOverAfter-parameter to none.

It is also possible to disable (or enable) both InactivityReset and TakeOver for a region. This can be done with the following commands:
/arm setinactivityreset <RegionId> (true/false)
/arm setinactivityreset rk:<RegionKind> (true/false)

Example

Imagine the following scenario: There is a server that gives free starter-regions to new players. New players often claim such a region, but log off after a short time and never visit the server again. This gives us the following problems:

• We quickly run out of starter-regions
• We have many starter regions with nothing built on them.

We can now do the following: We add a two permission-groups to our permission-plugin. Lets call this groups newbie and member. Newbies are all players that didn't play on the server for at least 2 hours. After 2 hours of playtime they get promoted to member. We want that regions that belong to a newbie-player get restored and put back on sale, after they didn't play on the server for a week.

We add the following permission to the member-group in our permission plugin: arm.inactivityexpiration.newbie.
Members get the following permission: arm.inactivityexpiration.member. The permission arm.inactivityexpiration.newbie that the newbies got is explicitly revoked from them. Members should not inherit that permission from newbies.

We now added assigned the newbie-InactivityExpiration-group to the newbies and the member-InactivityExpiration-group to members. But we didn't define these groups yet. As mentioned above we want that regions from newbies get restored after 7 days of inactivity. We also want to define a timer for normal players. We want that regions from normal players get restored after 60 days, but that other region-members of these regions can take over the regions after 50 days. All other groups that are not part of the newbie or member-group should get the timer set to unlimited and therefore disable to InactivityReset and Takeover-features completely. We can realize that behavior with the following configuration:

InactivityExpiration:
  newbie:
    resetAfter: 7d
    takeOverAfter: none
  member:
    resetAfter: 60d
    takeOverAfter: 50d

DefaultInactivityExpiration:
  resetAfter: none
  takeOverAfter: none