server/plugins/FastAsyncWorldEdit/config.yml

362 lines
17 KiB
YAML
Raw Normal View History

2018-05-25 17:23:59 +00:00
# These first 6 aren't configurable
2020-04-17 01:28:40 +00:00
issues: "https://github.com/IntellectualSites/FastAsyncWorldEdit/issues"
2022-04-08 18:51:32 +00:00
wiki: "https://intellectualsites.github.io/fastasyncworldedit-documentation/"
2023-06-24 17:23:14 +00:00
date: "Sun Jul 23 00:00:00 BRT 2023"
build: "https://ci.athion.net/job/FastAsyncWorldEdit/494"
commit: "https://github.com/IntellectualSites/FastAsyncWorldEdit/commit/ffa2a52f"
2020-04-17 01:28:40 +00:00
platform: "Bukkit"
2018-05-25 17:23:59 +00:00
# Set true to enable WorldEdit restrictions per region (e.g. PlotSquared or WorldGuard).
# To be allowed to WorldEdit in a region, users need the appropriate
# fawe.<plugin> permission. See the Permissions page for supported region plugins.
region-restrictions: false
# FAWE will cancel non admin edits when memory consumption exceeds this %
# - Bypass with `/wea` or `//fast` or `fawe.bypass`
# - Disable with 100 or -1.
2020-04-17 01:28:40 +00:00
max-memory-percent: 60
2018-05-25 17:23:59 +00:00
2021-01-20 05:36:18 +00:00
# Enable or disable core components
enabled-components:
commands: true
2021-08-25 06:29:13 +00:00
# Show additional information in console. It helps us at IntellectualSites to find out more about an issue.
# Leave it off if you don't need it, it can spam your console.
debug: false
2022-04-08 18:51:32 +00:00
# Whether or not FAWE should notify you on startup about new versions available.
update-notifications: false
2021-01-20 05:36:18 +00:00
2018-05-25 17:23:59 +00:00
clipboard:
# Store the clipboard on disk instead of memory
# - Will be slightly slower
# - Uses 2 bytes per block
use-disk: true
# Compress the clipboard to reduce the size:
# - TODO: Buffered random access with compression is not implemented on disk yet
# - 0 = No compression
# - 1 = Fast compression
# - 2-17 = Slower compression
2022-04-08 18:51:32 +00:00
# - levels over 6 require ZSTD 1.4.8+ to be installed to the system
2019-11-30 23:06:53 +00:00
compression-level: 0
2018-05-25 17:23:59 +00:00
# Number of days to keep history on disk before deleting it
delete-after-days: 1
2022-04-08 18:51:32 +00:00
# If a player's clipboard should be deleted upon logout
delete-on-logout: false
2023-06-24 17:23:14 +00:00
# Allows NBT stored in a clipboard to be written to disk
# - Requires clipboard.use-disk to be enabled
save-clipboard-nbt-to-disk: false
2018-05-25 17:23:59 +00:00
lighting:
# If packet sending should be delayed until relight is finished
2021-01-20 05:36:18 +00:00
delay-packet-sending: false
2018-05-25 17:23:59 +00:00
async: true
# The relighting mode to use:
# - 0 = None (Do no relighting)
# - 1 = Optimal (Relight changed light sources and changed blocks)
# - 2 = All (Slowly relight every blocks)
mode: 1
# If existing lighting should be removed before relighting
2020-01-04 19:34:14 +00:00
remove-first: false
2018-05-25 17:23:59 +00:00
# Generic tick limiter (not necessarily WorldEdit related, but useful to stop abuse)
tick-limiter:
# Enable the limiter
2020-02-08 01:30:21 +00:00
enabled: true
2018-05-25 17:23:59 +00:00
# The interval in ticks
interval: 20
# Max falling blocks per interval (per chunk)
falling: 10
# Max physics per interval (excluding redstone)
2020-02-08 01:30:21 +00:00
physics-ms: 10
2018-05-25 17:23:59 +00:00
# Max item spawns per interval (per chunk)
items: 20
2023-06-24 17:23:14 +00:00
# Web/HTTP connection related settings
2018-05-25 17:23:59 +00:00
web:
# The web interface for clipboards
# - All schematics are anonymous and private
# - Downloads can be deleted by the user
# - Supports clipboard uploads, downloads and saves
2021-08-25 06:29:13 +00:00
url: "https://schem.intellectualsites.com/fawe/"
2023-06-24 17:23:14 +00:00
# The maximum amount of time in seconds the plugin can attempt to load images for.
max-image-load-time: 5
# The maximum size (width x length) an image being loaded can be.
# - 8294400 is 3840x2160
max-image-size: 8294400
# Whitelist of hostnames to allow images to be downloaded from
# - Adding '*' to the list will allow any host, but this is NOT adviseable
# - Crash exploits exist with malformed images
# - See: https://medium.com/chargebee-engineering/perils-of-parsing-pixel-flood-attack-on-java-imageio-a97aeb06637d
allowed-image-hosts:
- "i.imgur.com"
2018-05-25 17:23:59 +00:00
extent:
# Don't bug console when these plugins slow down WorldEdit operations
2022-04-08 18:51:32 +00:00
# - You'll see a message in console or ingame if you need to change this option
2018-05-25 17:23:59 +00:00
allowed-plugins: []
# Should debug messages be sent when third party extents are used?
debug: false
# Experimental options, use at your own risk
# - UNSAFE = Can cause permanent damage to the server
# - SAFE = Can be buggy but unlikely to cause any damage
experimental:
# [UNSAFE] Directly modify the region files. (OBSOLETE - USE ANVIL COMMANDS)
# - IMPROPER USE CAN CAUSE WORLD CORRUPTION!
anvil-queue-mode: false
# [SAFE] Dynamically increase the number of chunks rendered
2020-04-17 01:28:40 +00:00
# - Requires Paper
2018-05-25 17:23:59 +00:00
# - Set your server view distance to 1 (spigot.yml, server.properties)
# - Based on tps and player movement
2019-07-23 23:07:06 +00:00
# - Note: If entities become hidden, increase the server view distance to 3
dynamic-chunk-rendering: -1
2019-07-23 23:07:06 +00:00
# Allows brushes to be persistent (default: true)
persistent-brushes: true
2018-05-25 17:23:59 +00:00
# [SAFE] Keep entities that are positioned in non-air blocks when editing an area
2022-04-08 18:51:32 +00:00
# Might cause client-side FPS lag in some situations
2018-05-25 17:23:59 +00:00
keep-entities-in-blocks: false
2023-06-24 17:23:14 +00:00
# [SAFE] Attempt to remove entities from the world if they were not present in the expected chunk (default: true)
# - Sometimes an entity may have moved into a different chunk to that which FAWE expected
# - This option allows FAWE to attempt to remove the entity, even if present in a different chunk
# - If the entity is in an unloaded or partially loaded chunk, this will fail
# - If an entity cannot be removed, it is possible duplicate entities may be created when using undo and/or redo
remove-entity-from-world-on-chunk-fail: true
2021-01-20 05:36:18 +00:00
# Other experimental features
other: false
2022-04-08 18:51:32 +00:00
# Allow fluids placed by FAWE to tick (flow). This could cause the big lags.
2021-01-20 05:36:18 +00:00
# This has no effect on existing blocks one way or the other.
2022-04-08 18:51:32 +00:00
# Changes due to fluid flow will not be tracked by history, thus may have unintended consequences
allow-tick-fluids: false
2021-01-20 05:36:18 +00:00
# Sets a maximum limit (in kb) for the size of a player's schematics directory (per-player mode only)
# Set to -1 to disable
per-player-file-size-limit: -1
# Sets a maximum limit for the amount of schematics in a player's schematics directory (per-player mode only)
# Set to -1 to disable
per-player-file-num-limit: -1
2018-05-25 17:23:59 +00:00
# This relates to how FAWE places chunks
queue:
progress:
# Display constant titles about the progress of a user's edit
# - false = disabled
# - title = Display progress titles
# - chat = Display progress in chat
display: "false"
# How often edit progress is displayed
interval: 1
# Delay sending progress in milliseconds (so quick edits don't spam)
delay: 5000
2022-04-08 18:51:32 +00:00
# This should equal the number of processors you have
parallel-threads: 2
2018-05-25 17:23:59 +00:00
# When doing edits that effect more than this many chunks:
# - FAWE will start placing before all calculations are finished
# - A larger value will use slightly less CPU time
# - A smaller value will reduce memory usage
# - A value too small may break some operations (deform?)
2023-06-24 17:23:14 +00:00
# - Values smaller than the configurated parallel-threads are not accepted
# - It is recommended this option be at least 4x greater than parallel-threads
2020-04-17 01:28:40 +00:00
target-size: 64
2018-05-25 17:23:59 +00:00
# Force FAWE to start placing chunks regardless of whether an edit is finished processing
# - A larger value will use slightly less CPU time
# - A smaller value will reduce memory usage
# - A value too small may break some operations (deform?)
2020-04-17 01:28:40 +00:00
max-wait-ms: 1000
2018-05-25 17:23:59 +00:00
# Increase or decrease queue intensity (ms) [-50,50]:
# 0 = balance of performance / stability
# -10 = Allocate 10ms less for chunk placement
2020-04-17 01:28:40 +00:00
# Too high can cause lag spikes (you might be okay with this)
2018-05-25 17:23:59 +00:00
# Too low will result in slow edits
extra-time-ms: 0
# Loading the right amount of chunks beforehand can speed up operations
# - Low values may result in FAWE waiting on requests to the main thread
# - Higher values use more memory and isn't noticeably faster
2021-08-25 06:29:13 +00:00
# - A good (relatively) safe way to set this is
2022-04-08 18:51:32 +00:00
# - Use 128 x GB of RAM / number of players expected to be using WE at the same time
# - Paper and derivatives only. (requires delay-chunk-unloads-by to be set).
2021-08-25 06:29:13 +00:00
preload-chunk-count: 16
2020-04-17 01:28:40 +00:00
# If pooling is enabled (reduces GC, higher memory usage)
# - Enable to improve performance at the expense of memory
pool: true
2018-05-25 17:23:59 +00:00
# Discard edits which have been idle for a certain amount of time (ms)
# - E.g. A plugin creates an EditSession but never does anything with it
# - This only applies to plugins improperly using WorldEdit's legacy API
discard-after-ms: 60000
2022-04-08 18:51:32 +00:00
# When using fastmode do not bother to tick existing/placed blocks/fluids
# Only works in versions up to 1.17.1
2021-01-20 05:36:18 +00:00
no-tick-fastmode: true
2018-05-25 17:23:59 +00:00
history:
# Should history be saved on disk:
# - Frees up a lot of memory
# - Persists restarts
# - Unlimited undo
# - Does not affect edit performance if `combine-stages`
use-disk: true
# Use a database to store disk storage summaries:
# - Enables inspection and rollback
# - Does not impact performance
use-database: true
# Record history with dispatching:
# - Much faster as it avoids duplicate block checks
# - Slightly worse compression since dispatch order is different
combine-stages: true
2021-08-25 06:29:13 +00:00
# Do not wait for a chunk's history to save before sending it
# - Undo/redo commands will wait until the history has been written to disk before executing
# - Requires combine-stages = true
send-before-history: true
2018-05-25 17:23:59 +00:00
# Higher compression reduces the size of history at the expense of CPU
# 0 = Uncompressed byte array (fastest)
# 1 = 1 pass fast compressor (default)
# 2 = 2 x fast
# 3 = 3 x fast
# 4 = 1 x medium, 1 x fast
# 5 = 1 x medium, 2 x fast
# 6 = 1 x medium, 3 x fast
# 7 = 1 x high, 1 x medium, 1 x fast
# 8 = 1 x high, 1 x medium, 2 x fast
# 9 = 1 x high, 1 x medium, 3 x fast (best compression)
# NOTE: If using disk, do some compression (3+) as smaller files save faster
2022-04-08 18:51:32 +00:00
# - levels over 6 require ZSTD 1.4.8+ to be installed to the system
2019-11-30 23:06:53 +00:00
compression-level: 0
2018-05-25 17:23:59 +00:00
# The buffer size for compression:
# - Larger = better ratio but uses more upfront memory
# - Must be in the range [64, 33554432]
buffer-size: 531441
# The maximum time in milliseconds to wait for a chunk to load for an edit.
# (50ms = 1 server tick, 0 = Fastest).
# The default value of 100 should be safe for most cases.
#
# Actions which require loaded chunks (e.g. copy) which do not load in time
# will use the last chunk as filler, which may appear as bands of duplicated blocks.
# Actions usually wait about 25-50ms for the chunk to load, more if the server is lagging.
# A value of 100ms does not force it to wait 100ms if the chunk loads in 10ms.
#
# This value is a timeout in case a chunk is never going to load (for whatever odd reason).
# If the action times out, the operation continues by using the previous chunk as filler,
# and displaying an error message. In this case, either copy a smaller section,
# or increase chunk-wait-ms.
# A value of 0 is faster simply because it doesn't bother loading the chunks or waiting.
2020-03-04 17:33:52 +00:00
chunk-wait-ms: 0
2018-05-25 17:23:59 +00:00
# Delete history on disk after a number of days
delete-after-days: 1
2018-05-25 17:23:59 +00:00
# Delete history in memory on logout (does not effect disk)
delete-on-logout: true
# If history should be enabled by default for plugins using WorldEdit:
# - It is faster to have disabled
# - Use of the FAWE API will not be effected
enable-for-console: false
2018-05-25 17:23:59 +00:00
# Should redo information be stored:
# - History is about 20% larger
# - Enables use of /redo
store-redo: true
# Assumes all edits are smaller than 4096x256x4096:
# - Reduces history size by ~10%
small-edits: false
# Paths for various directories
paths:
# Put any minecraft or mod jars for FAWE to be aware of block textures
textures: "textures"
heightmap: "heightmap"
history: "history"
# Multiple servers can use the same clipboards
# - Use a shared directory or NFS/Samba
clipboard: "clipboard"
2020-04-17 01:28:40 +00:00
# Each player has his or her own sub directory for schematics
2018-05-25 17:23:59 +00:00
per-player-schematics: false
2019-07-23 23:07:06 +00:00
# Region restriction settings
region-restrictions-options:
# What type of users are allowed to WorldEdit in a region
# - MEMBER = Players added to a region
# - OWNER = Players who own the region
mode: "MEMBER"
2022-04-08 18:51:32 +00:00
# Allow region blacklists.
# - Currently only implemented for WorldGuard
# - see region-restrictions-options.worldguard-region-blacklist
allow-blacklists: false
# List of plugin mask managers that should be exclusive. Exclusive managers are not
# checked for edit restrictions if another manager already allowed an edit, and further
# managers are not checked if an exclusive manager allows an edit.
# - May be useful to add PlotSquared if using both P2 and WorldGuard on a server
# - Some custom-implementations in other plugins may override this setting
exclusive-managers:
- "ExamplePlugin"
# If a worldguard-protected world should be considered as a region blacklist.
# - This will create a blacklist of regions where an edit cannot operate.
# - Useful for a "freebuild" worlds with few protected areas.
# - May cause performance loss with large numbers of protected areas.
# - Requires region-restrictions-options.allow-blacklists be true.
# - Will still search for current allowed regions to limit the edit to.
# - Any blacklist regions are likely to override any internal allowed regions.
worldguard-region-blacklist: false
2023-06-24 17:23:14 +00:00
# Restrict all edits to within the safe chunk limits of +/- 30 million blocks
# - Edits outside this range may induce crashing
# - Forcefully prevents any edit outside this range
restrict-to-safe-range: true
2018-05-25 17:23:59 +00:00
# The "default" limit group affects those without a specific limit permission.
# To grant someone different limits, copy the default limits group
# and give it a different name (e.g. newbie). Then give the user the limit
# permission node with that limit name (e.g. fawe.limit.newbie )
limits:
default:
# Max actions that can be run concurrently (i.e. commands)
max-actions: 1
# Max number of block changes (e.g. by `//set stone`).
2019-08-06 00:32:21 +00:00
max-changes: 2000000
2018-05-25 17:23:59 +00:00
# Max number of blocks checked (e.g. `//count stone` which doesn't change blocks)
2019-12-16 14:36:57 +00:00
max-checks: 2000000
2018-05-25 17:23:59 +00:00
# Number of times a change can fail (e.g. if the player can't access that region)
2019-12-16 14:36:57 +00:00
max-fails: 2000000
2018-05-25 17:23:59 +00:00
# Allowed brush iterations (e.g. `//brush smooth`)
max-iterations: 1000
# Max allowed entities (e.g. cows)
max-entities: 1337
# Blockstates include Banner, Beacon, BrewingStand, Chest, CommandBlock,
# CreatureSpawner, Dispenser, Dropper, EndGateway, Furnace, Hopper, Jukebox,
# NoteBlock, Sign, Skull, Structure
2019-07-23 10:06:39 +00:00
max-blockstates: 1337
2018-05-25 17:23:59 +00:00
# Maximum size of the player's history in Megabytes:
# - History on disk or memory will be deleted
2022-04-08 18:51:32 +00:00
max-history-mb: 100
2018-05-25 17:23:59 +00:00
# Maximum time in milliseconds //calc can execute
max-expression-ms: 50
# Cinematic block placement:
2020-04-17 01:28:40 +00:00
# - Adds a delay to block placement (nanoseconds/block)
2018-05-25 17:23:59 +00:00
# - Having an artificial delay will use more CPU/Memory
speed-reduction: 0
# Place chunks instead of individual blocks:
# - Disabling this will negatively impact performance
# - Only disable this for compatibility or cinematic placement
fast-placement: true
# Should WorldEdit use inventory?
# 0 = No inventory usage (creative)
# 1 = Inventory for removing and placing (freebuild)
# 2 = Inventory for placing (survival)
inventory-mode: 0
# Should large edits require confirmation (>16384 chunks)
2020-03-04 17:33:52 +00:00
confirm-large: false
2021-08-25 06:29:13 +00:00
# If undo and redo commands should be restricted to allowed regions
# - Prevents scenarios where players can delete/reset a region, and then continue to undo/redo on it
restrict-history-to-regions: true
2022-04-08 18:51:32 +00:00
# List of nbt tags to strip from blocks, e.g. Items
2019-07-23 23:07:06 +00:00
strip-nbt: []
2022-04-08 18:51:32 +00:00
# If the disallowed blocks listed in worldedit-config.yml should be disallowed in all edits,
# not just where blocks patterns are used.
# - Can prevent blocks being pasted from clipboards, etc.
# - If fast-placement is disabled, this may cause edits to be slower.
universal-disallowed-blocks: true
# List of blocks to deny use of. Can be either an entire block type or a block with a specific property value.
2023-06-24 17:23:14 +00:00
# Where block properties are specified, any blockstate with the property will be disallowed (e.g. all directions
# of a waterlogged fence). For blocking/remapping of all occurrences of a property like waterlogged, see
2022-04-08 18:51:32 +00:00
# remap-properties below.
2023-06-24 17:23:14 +00:00
# To generate a blank list, substitute the default content with a set of square brackets [] instead.
2022-04-08 18:51:32 +00:00
# Example block property blocking:
# - "minecraft:conduit[waterlogged=true]"
# - "minecraft:piston[extended=false,facing=west]"
# - "minecraft:wheat[age=7]"
2023-06-24 17:23:14 +00:00
disallowed-blocks: []
2022-04-08 18:51:32 +00:00
# List of block properties that should be remapped if used in an edit. Entries should take the form
# "property_name[value1_old:value1_new,value2_old:value2_new]". For example:
# - "waterlogged[true:false]"
# - "age[7:4,6:4,5:4]"
# - "extended[true:false]"
remap-properties: []