Config - CuzIm1Tigaaa/Spectator GitHub Wiki

config.yml

ATM the config contains `16` adjustable settings.

The first value `ConfigVersion` MUST NOT be changed! When there is an update for the config, the plugin will automatically creates a backup of your config and creates the new config.yml file. The current version is 10.

Main Section: Settings

The following config values are in the main section of the config file

Debugging

Default Value: false
Required Permission: ---
Description: Prints some debug messages in the console, can be helpful for reporting a problem

NotifyOnUpdate

Default Value: true
Required Permission: spectator.notify.update
Description: Notifies players when they join, if there is an update available

Language

Default Value: en_US
Description: Select a language file.
- The plugin provides to files by default: en_US, de_DE
- You can create own language file and send them to me of course :)

HidePlayersInTab

Default Value: true
Required Permission: spectator.utils.hidetab
Description: Hide spectators for player without following permission spectator.bypass.tablist

KickCyclingPlayers

Default Value: false
Required Permission: ---
Description: Cycling players cannot be kicked by any other player

NotifyCurrentTarget

Default Value: NONE
Possible Values: CHAT, ACTIONBAR, TITLE, SUBTITLE, NONE
Required Permission: spectator.bypass.notify to Bypass for certain players
Description: Shows a message to target players that they are being spectated

Sub-Section Save

The following config values are located in the sub section 'Save'

PlayerLocation

Default Value: true
Required Permission: ---
Description: The players' location (where he executed /spec) will be saved

PlayerFlightMode

Default Value: true
Required Permission: ---
Description: The players' flight mode will be saved - Requires allow-flight to true in server.properties!

PlayerData

Default Value: true
Required Permission: ---
Description: The players' remaining air and burning time are saved when joining spectator mode and applied back when leaving spectator mode

Sub-Section Mirror

The following config values are located in the sub section 'Mirror'

TargetEffects

Default Value: true
Required Permission: spectator.utils.mirroreffects
Description: Get all effects your spectator target currently has

TargetInventory

Default Value: true
Required Permission: spectator.utils.mirrorinventory
Description: Adds all inventory content of your spectator target in your inventory

Sub-Section Inventory

The following config values are located in the sub section 'Inventory'

OpenContainers

Default Value: true
Required Permission: spectator.utils.opencontainers
Description: Allows spectators to see into containers their target opens. Only available for the following containers:
- BARREL; BLAST_FURNACE; BREWING_STAND; (TRAPPED-)CHEST; DISPENSER; DROPPER; FURNACE; HOPPER; SMOKER; SHULKER_BOX; LECTERN

OpenEnderchest

Default Value: false
Required Permission: spectator.utils.openenderchest
Description: Allows spectators with the following permission to see into their target's enderchest. Only when the target opens a physically enderchest!

Sub-Section Cycle

The following config values are located in the sub section 'Cycle'

StartWhenNoPlayers

Default Value: true
Required Permission: ---
Description: Allows starting cycling even with no players online. Cycle will then work, when players are online! Might be useful when using the plugin as a "camera"

PauseWhenNoPlayers

Default Value: false
Required Permission: ---
Description: The cycle gets paused if there are no longer any players online and will automatically restart. Otherwise the cycle will simply be stopped

ShowCurrentTarget

Default Value: BOSSBAR
Possible Values: BOSSBAR, ACTIONBAR, TITLE, SUBTITLE, NONE
Required Permission: ---
Description: Shows a message to cycling players with the name of the current target. Possible values are: "BOSSBAR", "ACTIONBAR", "NONE"