[WIP] V2 Code Refactoring

[phoenixlzx]

Features

• Server Monitor
  • TPS
  • Current Tick speed
  • Entity Amount Counter
  • Entity Tick Time Counter
  • Redstone Event Counter
  • Redstone Tick Time Counter
  • Chunk Tick Time Counter
• Modules
  • Random tick speed auto-adjustments
  • Entity AI Suppressor
  • Entity Culler
  • Redstone Suppressor
  • Command Executor

Design

The plugin should be modular. It has 3 major parts:

• Status Monitor, that continuously monitors many aspect of the server, and invoke corresponding operations when a rule is met.
• Operations Manager, manages operations, which are the instances of each "feature module" with actual parameters. Operations are used in rules.
• Rules Handler, defines rules in which situation that should apply with one or more operations to maintain the server stability and gaming experience.

Commands

Command	Permission	Description
/yasui status	yasui.command.status	Shows current server overall status with some statistics.
/yasui chunks [world]	yasui.command.chunks	Shows top-N chunks that consuming most of the tick time. If [world] is supplied, shows data for that specific world. Otherwise use the world which the executor is in.
/yasui counter <entity\|redstone> [world]	yasui.command.counter	Shows top-N entity or redstone counter data that consuming most of the tick time. entity lists LivingEntity and All Other categories, while redstone lists Redstone and Physics categories.
/yasui operation <engage\|release> <operation> [world\|all]	yasui.command.operation	Manually engage or release operation to a specific world, or the world which player is in, or all worlds.
/yasui reset	yasui.command.reset	Reset Yasui's counters and statistics. This will not reload the configurations and operation status.
/yasui reload	yasui.command.reload	Reload the plugin and configuration, check and update all the settings/operations/rule definitions as well as reset all counters.

Configuration example

config.yml

language: en_US
enable: true  # global switch
scan_interval_tick: 600
broadcast: CHAT # CHAT | SUBTITLE | ACTIONBAR | ADMIN_CHAT | NONE
top_listing: 10
modules: # Comment out any of the below will disable all its operations.
- entity_ai_suppressor
- entity_culler
- redstone_suppressor
- random_tick_speed
- command_executor

Operation files are placed under operations/ directory, with operation name as the file name, and module name as root variable name in the file, along with its parameters.

Operation names use hyphens, while feature module names use underscores.

• Operation: suppress-entity-ai - operations/suppress-entity-ai.yml

# Suppress entity AI on engage, or restore them on release.
entity_ai_suppressor:
  method: NO_TARGETING # NO_TARGETING | NO_AI | NERFING
  exclude: # entities won't be suppressed, typically used with mob farms that take adv of entity anger
    type:
    - PIG_ZOMBIE
    - ENDERMAN
    tagged: false  # has custom name or tag
    tamed: false  # has owner

• Operation: cull-entity - operations/cull-entity.yml

# Cull mobs and disable new mob spawns on engage, enable new mob spawns on release.
entity_culler:
  excluded:
    type:
    - DOLPHIN
    - SNOWMAN
    tagged: true
    tamed: true
  per_chunk_limit: 12
  per_region_limit: 30

• Operation: suppress-redstone - operations/suppress-redstone.yml

# Suppress redstone currents on engage, lift cancellation on release.
# Note: Yasui should always set NewCurrent = OldCurrent to keep consistency of redstone mechanics.
redstone_suppressor:
  event_thresholds:
    count_per_chunk: 12000 # 12000 events in 'scan_interval_tick'
    count_piston_per_chunk: 120 #  120 piston events in 'scan_interval_tick'
  supress_chunk_region: 1 # redstone in nearby 3x3 chunks will be supressed

• Operation: adjust-random-tick-speed - operations/adjust-random-tick-speed.yml

# Decrease random tick speed by 1 on engage, increase by 1 on release.
random_tick_speed:
  min: 1
  max: 3

• Operation: custom-command - operations/custom-command.yml

# Execute command on engage or release.
command_executor:
  engage: 'essentials:killall entities all'
  release: '' # empty string will not do anything

Rule files are placed under rules/ directory.

• rules/suppress-ai.yml - Example rule to suppress AI on high mob load.

enabled: true
operations: 
- 'suppress-entity-ai'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_1m < 18.0 && world_living_entities > 2000
  message: '&b[YASUI] &c[ENGAGED] &6Entity AI Suppressed'
release:
  condition: tps_1m > 19.5
  message: '&b[YASUI] &a[RELEASED] &6Entity AI Recovered'

• rules/adjust-random-tick.yml - Example rule to auto adjust random tick speed according to server load.

enabled: true
operations: 
- 'adjust-random-tick-speed'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_5m < 17.0
  message: '&b[YASUI] &c[ENGAGED] &6Random Tick Speed: &d{world_random_tick_speed}'
release:
  condition: tps_5m > 19.0
  message: '&b[YASUI] &c[RELEASED] &6Random Tick Speed: &d{world_random_tick_speed}'

• rules/suppress-redstone.yml

enabled: true
operations: 
- 'suppress-redstone'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_5m < 15.0
  message: '&b[YASUI] &c[ENGAGED] &6Redstone Suppressed'
release:
  condition: tps_5m > 19.0
  message: '&b[YASUI] &c[RELEASED] &6Redstone Recovered'

• rules/cull-entity.yml

enabled: true
operations: 
- 'cull-entity'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_5m < 17.0 && world_entity > 2000
  message: '&b[YASUI] &c[ENGAGED] &6EntityLimit Engaged'
release:
  condition: tps_5m > 19.0
  message: '&b[YASUI] &c[RELEASED] &6EntityLimit Released'

[phoenixlzx]

问题：

• [x] rules 不断被重复触发、重复发广播
• [x] 手动 engage/release operation 需要命令反馈

[phoenixlzx]

新需求： region

• /yasui region create [region name] 保存 WE 选区内的所有区块为新的 region
• /yasui region rule [region name] [rule name] [bypass|enforce] 设置 region 的 bypass 属性
• /yasui region list 列出所有 region 信息和配置
• /yasui region [enable|disable] [region name] - 设置是否启用此 region 配置

region/region-name.yml

enabled: true
region:
  minChunkX: 7
  minChunkZ: 11
  maxChunkX: 10
  maxChunkZ: 16
bypass:
  - cull-entity  # rule names
  - suppress-redstone

[phoenixlzx]

New config option - broadcast messages destination

broadcast:
  type: CHAT
  log_console: true
  permission: yasui.command.status

Only players with yasui.command.status permission will receive the broadcast message.

update - Entity Culler (paper)

• Used as the last defense against mob lag.
• Gradually remove all the overloaded mob according to configuration.
• Also listen to pre spawn events and cancel all (pre spawn and creature spawn) entity spawns for better performance.
• Cancel all reasons (except custom/plugin) spawning

Mobcap implementation (paper)

• Remove entity limit implementation from operations/cull-entity it should work together with cull-entity
• Implement operations/mobcap using Paper API and Spigot API (fallback)

API reference:

• https://papermc.io/javadocs/paper/1.14/com/destroystokyo/paper/event/entity/PreCreatureSpawnEvent.html
• https://papermc.io/javadocs/paper/1.14/com/destroystokyo/paper/event/entity/PlayerNaturallySpawnCreaturesEvent.html
• https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.html (as fallback)

Module mobcap

Operation operations/mobcap.yml

If engaged, new mob will not naturally spawn when:

• total mob count in current world is higher than soft limit

new mob will not spawn for most of the reasons (except custom/plugin) when:

• total mob count in current world is higher than hard limit or
• mob count in current chunk is higher than default or [chunk type-specific] limit or
• mob count in current world is higher than [global type-specific] limit

Note:

• Type-specific limit should always overwrite the default limit
• Yasui should cache values for chunk and mob counting (reason: /yasui status causes lag)

mobcap:
  global:
    soft: 1600
    hard: 2400
    types:
    - VILLAGER: 100
    - PILLAGER: 100
    - PIG_ZOMBIE: 200
  chunk:
    default: 32
    types:
    - VILLAGER: 4
    - PILLAGER: 4
    - CHICKEN: 8

Rule rule/mobcap.yml

enabled: false
operations: 
- 'mobcap'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_5m < 17.0 && world_living_entities > 1500
  message: '&b[YASUI] &c[ENGAGED] &6Mob spawn limited'
release:
  condition: tps_5m > 19.5
  message: '&b[YASUI] &c[RELEASED] &6Mob spawn lifted'

Dynamic View Distance (Paper)

• Reduce player VD on engage
• Recover player VD on release

API reference

• https://papermc.io/javadocs/paper/1.14/org/bukkit/entity/Player.html#setViewDistance-int-

Module adjust-view-distance

Operation operation/adjust-view-distance.yml

Reduce player view distance by 1 on engage, and increase by 1 on release, to the minimum or maximum value.

adjust-view-distance:
  min: 6
  max: 10

Rule rule/adjust-view-distance.yml

enabled: false
operations: 
- 'adjust-view-distance'
worlds:
- world
- world_nether
- world_the_end
engage:
  condition: tps_5m < 16.0 && world_chunks > 5000
  message: '&b[YASUI] &c[ENGAGED] &6View Distance &d{world_view_distance}'
release:
  condition: tps_5m > 19.0
  message: '&b[YASUI] &c[RELEASED] &6View Distance &d{world_view_distance}'