Configuration - InsightsPlugin/Insights GitHub Wiki
This file is the main configuration file of Insights v6. The configfile will be automatically kept up to date, so you don't have to worry about manually updating config entries.
The default configuration:
settings:
update-checker:
enabled: true
interval-seconds: 10800
scans:
concurrent-threads: -1
iteration-interval-ticks: 1
chunks-per-iteration: 256
info-interval-millis: 100
chunk-scans:
mode: "ALWAYS"
player-tracker-interval-ticks: 5
notification:
type: "BOSSBAR"
bossbar:
color: "BLUE"
style: "NOTCHED_10"
flags: []
duration-ticks: 60
actionbar:
segments: 50
progress-sequence: "|"
done-color: "&a"
total-color: "&8"
separator: " "
area-scan-notifications:
enabled: true
permission: ""
spigot:
entity-tracker-interval-ticks: 10
apply-piston-limits: true
pagination-results-per-page: 6
disabled-listeners:
- "BlockFromToEvent"
- "FluidLevelChangeEvent"
- "SpongeAbsorbEvent"
- "LeavesDecayEvent"
listener-priorities:
BlockPlaceEvent: LOWEST
HangingPlaceEvent: LOWEST
EntityPlaceEvent: LOWEST
BlockPistonExtendEvent: LOWEST
BlockPistonRetractEvent: LOWEST
redstone-update-limiter:
enabled: false
limit: 50000
aggregate-ticks: 10
aggregate-size: 30
block-outside-region: falseDescription: Whether or not the periodically update checker should be enabled.
Values: Boolean
Default: true
Description: Configures how many seconds must be in between update checks.
Values: Integer
Default: 10800 (3 hours)
Description: This setting configures the amount of threads Insights will use for scanning. A value of -1 means all threads will be used.
Values: Integer
Default: -1
Description: The interval of a scan task. This configures how frequent iterations will take place.
Values: Integer (ticks)
Default: 1
Description: This configures how many chunks Insights should scan each iteration. Although the default value is set to 2, you can likely set this value much higher for faster scans.
Values: Integer
Default: 256
Description: Configures the interval of broadcasting progress to the user (through bossbar/actionbar).
Values: Integer (milliseconds)
Default: 100
Description: Determines the scanning mode of Insights. When ALWAYS is used, Insights will scan loaded chunks around the player on a given tick interval. Insights will only scan loaded chunks, and will never load chunks with this method. This makes it extremely fast and results in minimal impact of Insights onto your players in contrast to the MODIFICATION scan mode, which will block the first block placement(s) and until the chunk is scanned (scanning is triggered when a modification is made).
Values: ALWAYS, MODIFICATION
Default: ALWAYS
Note: Although ALWAYS may sound as an expensive task to do, it is in fact not, as chunks are scanned 100% asynchronously.
Description: The interval in ticks for the task which is used when the scan mode is set to ALWAYS. Higher values mean less iterations over all, but may result in delays until chunks are scanned when a player enters them.
Values: Integer
Default: 5
Description: This setting configures the notification type of Insights when displaying limits, or when displaying progress of a scan.
Values: BOSSBAR, ACTIONBAR
Default: BOSSBAR
Description: This represents the color of the bossbar.
Values: PINK, BLUE, RED, GREEN, YELLOW, PURPLE, WHITE
Default: BLUE
Description: This represents the style (amount of segments) of the bossbar.
Values: PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12, NOTCHED_20
Default: NOTCHED_10
Description: This list allows you to configure any flags you may want to give to the bossbar, while it is being displayed.
List Values: DARKEN_SCREEN, PLAY_BOSS_MUSIC, CREATE_WORLD_FOG
Default: []
Description: This is the timeout for the bossbar, ie after how many ticks it will disappear after being shown.
Values: Integer
Default: 60
Description: The amount of segments the progressbar should consist of.
Values: Integer
Default: 50
Description: This allows you to configure how a single segment looks like.
Values: String
Default: |
Description: The color used to indicate "done"
Values: String
Default: &a
Description: The color used to indicate "not yet done"
Values: String
Default: &8
Description: The separator used for separating the progress bar from text.
Values: String
Default:
Description: Whether or not to enable area scan notifications (started, queued, completed) when an area is being scanned.
Values: Boolean
Default: true
Description: The permission required to view area scan notifications (started, queued, completed) when an area is being scanned.
Values: String
Default: <EMPTY>
Description: This setting is only used on spigot servers (paper & forks have proper events to detect this). It configures the interval for which insights will check all entities to detect which ones have been removed for unknown reasons from the world.
Values: Integer (ticks)
Default: 10
Description: This setting allows you to toggle whether or not Insights should purposefully cancel piston movements whenever a limit has been reached. Insights always cancels the first piston movement, as it needs to scan the chunk/area (asynchronously) first. Pistons will behave normally after the area has been scanned. This process of scanning is fairly quickly (also depending on the setting you chose above for chunks-per-iteration if addons are installed).
Values: Boolean
Default: true
Description: The amount of results displayed per page after scanning.
Values: Integer
Default: 6
Description: This setting allows you to disable arbitrary cache listeners from Insights, ie to prevent lag on very heavily called events. An example of this is to disable fluids, as these events may be called hundreds of times per second on busy servers.
List Values: BlockBurnEvent, BlockDispenseEvent, BlockExplodeEvent, BlockFadeEvent, BlockFromToEvent, FluidLevelChangeEvent, BlockGrowEvent, BlockIgniteEvent, BlockPistonExtendEvent, BlockPistonRetractEvent, BlockSpreadEvent, EntityBlockFormEvent, LeavesDecayEvent, SpongeAbsorbEvent
Default: [BlockFromToEvent, FluidLevelChangeEvent, SpongeAbsorbEvent, LeavesDecayEvent]
Description: This setting allows to configure the event priorities for events where Insights may cancel them if a limit is reached.
Events: BlockPlaceEvent, HangingPlaceEvent, EntityPlaceEvent, BlockPistonExtendEvent, BlockPistonRetractEvent
Values: LOWEST, LOW, NORMAL, HIGH, HIGHEST
Default: LOWEST
Description: Whether or not to enable the redstone update limiter. This limiter works by collecting redstone updates, grouping them per X ticks (configured by aggregate-ticks). After Y of these groups have been created (configured by aggregate-size), the first group is cleared. Thus if 30 groups exist, and we're currently collecting for the 30th group, group 1 is cleared. After X ticks we're collecting for group 1 again, and group 2 is cleared. The limiter will block redstone updates if the sum of all groups is greater than limit.
Values: Boolean
Default: false
Description: The maximum amount of redstone updates in given chunk / area.
Values: Integer
Default: 50000
Description: The time in ticks in which we should group redstone updates.
Values: Integer
Default: 10
Description: The amount of groups.
Values: Integer
Default: 30
Description: Whether or not to block redstone updates outside regions.
Values: Boolean
Default: false