XenoWorldReset
config.yml
The main configuration file for XenoWorldReset.
###############################################################################
# _ _ ____ _ _ ____ _ _ _ ____ ____ _ ___ ____ ____ ____ ____ ___ #
# \/ |___ |\ | | | | | | | | |__/ | | \ |__/ |___ [__ |___ | #
# _/\_ |___ | \| |__| |_|_| |__| | \ |___ |__/ | \ |___ ___] |___ | #
# #
# Premium Software | BitAspire.com #
# ZeroToil LLC is the owning entity of BitAspire.com #
# #
# --> WIKI: https://wiki.bitaspire.com/en/docs/xenoworldreset <-- #
# --> Discord: https://discord.gg/DC4Gqj3y5V <-- #
# #
# Thank you for your purchase of XWR Premium! We really appreciate #
# your support. We strive to produce quality plugins. If you run #
# into any issues or have any questions, feel free to reach out on #
# Discord or to Kihsomray on SpigotMC or Polymart. #
# #
###############################################################################
#
config:
##############################
# #
# Command Confirmation #
# #
##############################
# Command confirmation requires the command sender to confirm
# the command before it can be executed. The command confirmation
# will expire after the amount of seconds below.
#
# We encourage enabling reset confirmation and teleport
# confirmation if the teleport cost is not free.
confirmation:
enabled: true
seconds: 15
# Enable the sub commands below that you would like players
# or admins to confirm before execution.
sub-commands:
create: true
reset: true
save: false
teleport: true
edit: false
# Enabling this will allow operators to bypass any type of
# confirmation entirely.
bypass-op: true
##############################
# #
# Teleportation Settings #
# #
##############################
# These settings are primarily used for standard and random
# teleportation to an RTP world or resetting world.
teleport:
# Countdown requires the player to stand still for the amount
# of seconds mentioned below. If they move or are damaged
# within that time, their teleportation will be cancelled.
countdown:
enabled: true
seconds: 5
# Cooldown requires the player to wait a set amount of time
# before they can teleport again. Type allows the timer to
# be saved globally (for all worlds) or per world.
#
# Type options:
# --> 'GLOBAL' - Global cooldown
# --> 'WORLD' - Per world cooldown
cooldown:
enabled: true
type: GLOBAL
seconds: 300
# TP blacklist blocks restricts the blocks a player can be
# teleported onto. This includes both random and standard
# teleportation to a world (not including world spawn).
#
# These must be block IDs as mentioned in the link below.
# 1.19 Blocks: https://bit.ly/3BHvuEj
tp-blacklist-blocks:
- LAVA
- WATER
- CACTUS
- MAGMA_BLOCK
- FIRE
- SOUL_FIRE
# If the location is unsafe, should the chunk be searched
# before deeming the location unsafe? This feature will also be
# used with the fix for the incorrect world bug.
search-chunk-for-safety: true
##############################
# #
# Random Teleport Settings #
# #
##############################
# These settings will only apply to world setups with random
# teleport enabled. Please be considerate of your machine's
# specifications and do not over-stress it. If you are unsure,
# feel free to ask on our Discord (top of this file).
#
# If you are running on a Paper fork, RTP will function in
# an asynchronous manner with minimal lag generated.
rtp-settings:
# How long should XWR search for safe random location and
# load a chunk before teleporting the player there? The
# search will time out after this amount of ticks.
ticks: 2000
# How many times should XWR try to find a location before
# completely giving up the search attempt? The search will
# time out after this amount of attempts.
attempts: 15
# What interval in ticks should there be between RTP search
# attempts? Don't set this too high or too low.
interval: 4
# What height below the top block should the search begin
# at in the overworld dimension?
overworld-start-below: 8
# What is the minimum y level that the search should start?
# set to 'AUTO' to automatically determine the minimum y level.
# NOTE: adjusting this value will override any calculations.
min-y:
overworld: AUTO
nether: AUTO
end: AUTO
# What is the maximum y level that the search should end?
# set to 'AUTO' to automatically determine the maximum y level.
# NOTE: adjusting this value will override any calculations.
max-y:
overworld: AUTO
nether: AUTO
end: AUTO
# RTP saved locations will attempt to locate a random
# location in the background. When a player wants to teleport
# and there is a saved location, it will utilize it.
#
# This feature reduces stress on your machine when a player
# is being randomly teleported.
saved-locations:
enabled: true
# The interval, in seconds, between searching for a location.
interval: 120
# The tolerance, in seconds, will 'randomize' the interval
# so multiple worlds do not attempt to search simultaneously.
tolerance: 60
# The maximum number of locations that a world can save in
# the background for instant teleportation.
max-locations: 30
# Safety options for teleportation.
safety:
# Should fall damage be prevented when a player is teleported
# to a random location? This feature negates any prior fall
# damage to the event.
negate-fall-damage: true
##############################
# #
# Spawn Loading Settings #
# #
##############################
# XenoWorldReset is unique in its ability to generate spawn
# chunks when a world is being created. Although I cannot
# change how a world is loaded, I can change how a world's
# spawn chunks are loaded to reduce instantaneous stress.
#
# Below I have created a few preset spawn chunk loading
# types. If you do not wish to tweak the individual settings,
# using the best method will be most helpful to you.
#
# Best types for:
# --> Bukkit/Spigot - NORMAL
# --> Paper/Purpur/other - SMART
#
# Available loading types:
#
# --> 'STANDARD' - Typical Bukkit spawn chunk loading method.
# - NOT recommended: drops TPS & causes lag.
#
# --> 'SMART' - Loads chunks ASAP, taking TPS into account.
# - Recommended for Paper forks: async loading.
#
# --> 'NORMAL' - Loads chunks at an average speed.
# - Recommended for Bukkit/Spigot: sync loading.
#
# --> 'ULTRA-FAST' - Skips spawn chunk loading entirely.
# - Recommended for rollback worlds.
#
# --> 'ULTRA-SAFE' - Loads chunks REALLY slowly.
# - Recommended for microwaves & fridges.
#
# --> 'FAST' - Loads chunks fast, different from ULTRA-FAST.
# - Recommended for NASA machines.
#
# --> 'SAFE' - Loads chunks slow, similar to ULTRA-SAFE.
# - Recommended for 90's PCs and smart fridges.
#
loading-type: SMART
# Radius of chunk loading if SMART, FAST, NORMAL, SAFE or
# ULTRA-SAFE is enabled.
#
# Please DO NOT use for loading mass amounts of chunks! Your
# machine WILL run out of memory, causing a crash! The chunks
# have a ticket added to them, preventing unloading, until
# all chunks have been loaded.
loading-radius: 3
# Loading override is tool used to override loading speed to
# custom values. DO NOT mess with these settings if you do not
# know what you are doing. It could even lead to a crash!
#
# Will override SMART, FAST, NORMAL, SAFE and ULTRA-SAFE.
loading-override:
enabled: false
# interval between iteration of chunk loading. less = faster
ticks-per-iteration: 3
# how many chunks should load in every iteration? MAX: 25
chunks-per-iteration: 3
# initial chunk load time. less = faster
initial-chunk-ticks: 200
##############################
# #
# Other Settings #
# #
##############################
# Recently, Paper introduced a new file within a world's folder
# called 'paper-world.yml' which saves additional settings for
# that specific world only. This option enabled the contents of
# that file to be transferred over to the newly reset world.
save-paper-world-yml: true
# should the world be backed up before a reset is initialized?
save-world-before-reset: false
# Portal linking is used to relink portals from one world to
# another. When a player enters through a portal, they will
# be teleported to the corresponding world.
#
# Keep in mind: when a player enters a portal in the first world
# they will be teleported to the second world, but not in reverse.
# Be sure to include it the other way if you want it to be
# linked both directions (as shown below).
#
# Directions are separated by a colon (:).
#
# Example linking both ways:
# - 'world:world_nether'
# - 'world_nether:world'
portal-linking:
nether-portal:
- world_from:world_to
end-portal:
- world_from:world_to
# Fixes issue where players are teleported to the same coords
# in another world when they log back in after a reset.
fix-incorrect-world-bug: true
# Amount of time between copies/pastes of regions. Default is
# highly recommended with FAWE. Value is in ticks.
saving-region-stall:
copy: 1
paste: 12
# Folders to place saved worlds & schematics into. The folder
# will automatically be created as needed.
folders:
saved-worlds: 'saved_worlds'
saved-schematics: 'saved_schematics'
# Additional hook settings are displayed here.
hooks:
# Should CMI warps be saved after a world resets?
save-cmi-warps: true
# Should transferred regions be saved to file?
save-copied-regions: true
# WorldEdit schematic extension when copying/pasting.
we-schematic-extension: 'schem'
# Should WorldEdit regions ignore air blocks when pasting?
we-ignore-air-blocks: true
# Should WorldEdit biomes be transferred when pasting regions?
we-paste-biomes: false
# Updates the config every time you update. Prior strings will
# remain the same! NOTE: disabling this will leave new settings
# as default and new lang string won't send.
auto-update:
config-yml: true
lang-yml: true
# Should console messages send with color? This option should
# be disabled if XWR console messages contain weird chars.
console-color: true
# Debug shows a bunch of messages in chat and console. Used for
# testing new features and fixing certain bugs.
debug: false
# Delay in ticks before unloading world (20 ticks = 1 second)
# This helps prevent issues with file handles during world deletion
unload-delay: 20
# Do not touch unless asked by BitAspire Team!
version: 1.1Last updated on