# FAWEReplace<\/p>\n
## Introduction<\/p>\n
FAWEReplace is a high-performance Paper plugin designed for large-scale Minecraft world cleanup tasks. Built on FastAsyncWorldEdit (FAWE)’s asynchronous capabilities, it efficiently handles bulk block replacement and entity removal operations.<\/p>\n
## Prerequisite<\/p>\n
FastAsyncWorldEdit (FAWE)<\/p>\n
## Tutorial<\/p>\n
### Commands<\/p>\n
* start\/continue cleaning: `\/frl start`
\n * start new cleaning task: `\/frl start –fresh`
\n * stop cleaning: `\/frl stop`
\n * check cleaning progress: `\/frl status`
\n * tutorial: `\/frl help`
\n * reload: `\/frl reload`<\/p>\n
### Configuration<\/p>\n
“`yaml
\nlanguage: zh_CN # or en_US<\/p>\n
# Target region coordinates
\nworld: “world”
\ntarget:
\n start:
\n x: -1000
\n z: -1000
\n # y: -64 # Optional: auto use full world height if not set
\n end:
\n x: 1000
\n z: 1000
\n # y: 320 # Optional: auto use full world height if not set<\/p>\n
# Auto-start on plugin enable
\n# !Warning: Recommend keeping false, manual start is safer
\nconfirm: false<\/p>\n
# Performance Configuration<\/p>\n
# Number of parallel processing threads
\n# !Important: Choose value based on your use case
\n#
\n# Server with players online:
\n# – 2GB RAM: 1-2 threads
\n# – 4GB RAM: 2-3 threads
\n# – 5GB RAM: 2-3 threads (recommended: 2)
\n# – 8GB+ RAM: 3-5 threads
\n#
\n# Offline processing (maximum performance):
\n# – 4GB RAM: 4-6 threads
\n# – 5GB RAM: 6-8 threads
\n# – 8GB RAM: 8-12 threads
\n# – 16GB+ RAM: 12-16 threads
\n#
\nparallel: 2<\/p>\n
# Region\/Tile size
\n# Size of region each worker thread processes
\n# Larger values = fewer tiles but longer processing time per tile
\nregion:
\n x: 512
\n z: 512
\n # y: 256 # Optional: auto-calculated if not set<\/p>\n
# Processing Modes
\n# Tiling mode
\n# When enabled, splits large regions into smaller tiles for parallel processing
\ntiling:
\n enabled: true<\/p>\n
# Fast mode
\n# Uses FAWE’s fast asynchronous processing
\nfast-mode: true<\/p>\n
# Progress log frequency
\n# Output progress log every N tiles processed
\n# Tip:
\n# – Online server: 50-100 (more detailed progress)
\n# – Offline processing: 100-200 (reduce log overhead)
\nprogress-log-every: 100<\/p>\n
# Safety Options
\n# Skip ungenerated chunks
\n# Highly recommended to keep enabled
\n#
\n# Features:
\n# – Only process chunks visited by players
\n# – Avoid generating new empty chunks
\n# – Prevent heightmap warnings
\n# – Improve performance
\n#
\nskip-ungenerated-chunks: true<\/p>\n
# Auto-repair chunk heightmaps
\n# Recommended to prevent black chunks in MCA Selector
\n#
\n# Features:
\n# – Auto-refresh heightmap after block replacement
\n# – Prevent black chunks in MCA Selector
\n# – Minimal performance impact
\nauto-fix-heightmap: true<\/p>\n
# Memory Protection
\n# Prevent OutOfMemoryError crashes
\nmemory-protection:
\n # Enable automatic memory monitoring
\n # Recommended: Must enable for online servers
\n # Offline processing: Can disable for max speed (with crash risk)
\n enabled: true<\/p>\n
# Minimum free memory percentage (0.0-1.0)
\n # Pause processing when free memory falls below this
\n #
\n # !Recommended values:
\n # Online server: 0.20-0.25 (20-25%, safer)
\n # Offline processing: 0.10-0.15 (10-15%, aggressive)
\n min-free-memory-percent: 0.20<\/p>\n
# Wait time when memory is low (milliseconds)
\n # !Recommended values:
\n # Online server: 5000 (5 seconds)
\n # Offline processing: 2000-3000 (2-3 seconds)
\n wait-on-low-memory-ms: 5000<\/p>\n
# Maximum retries when memory is consistently low
\n # Set to -1 for unlimited retries (not recommended)
\n max-memory-retries: 10<\/p>\n
# Performance Throttling
\n# Add delays between operations to reduce server load
\n# !IMPORTANT:
\n# Server with players: Use moderate delays
\n# Offline processing: Set all to 0 for maximum speed (10-40% faster!)
\nperformance:
\n # Delay between chunk processing batches (milliseconds)
\n # Recommended values:
\n # Offline: 0 (\u6700\u5927\u901f\u5ea6 \/ max speed)
\n # Online-light: 50-100
\n # Online-heavy: 100-200
\n delay-between-batches-ms: 100<\/p>\n
# Delay between individual chunk operations (milliseconds)
\n # Recommended values:
\n # Offline: 0 (max speed)
\n # Online: 10-20
\n delay-between-chunks-ms: 20<\/p>\n
# Force garbage collection frequency
\n # Execute GC every N chunks processed
\n # Recommended values:
\n # Offline: 0 (let JVM auto-manage, fastest)
\n # Memory issues: 100-200
\n # !Note: 0 is usually best, JVM’s GC optimization is more efficient
\n gc-every-chunks: 50<\/p>\n
# Resume\/Checkpoint System
\n# Save progress to resume after interruption
\nresume:
\n # Enable resume\/checkpoint
\n # Recommended: keep enabled
\n enabled: true<\/p>\n
# Progress file name
\n # Saved in plugin data folder
\n file: “progress.yml”<\/p>\n
# Save frequency
\n # Save progress every N tiles processed
\n # Recommended values:
\n # – Online server: 25 (save more frequently)
\n # – Offline processing: 100 (reduce I\/O overhead)
\n save-every: 25<\/p>\n
# Block Replacement Rules blocks: # Entity Cleanup entities: Replace blocks and entities for large regions using the FAWE API.<\/p>\n","protected":false},"featured_media":69531,"template":"","meta":{"_minecraft_slug":"fawereplace","_minecraft_project_id":"amx0ojj5","_minecraft_author":"angushushu","_minecraft_license":"LGPL-3.0-only","_minecraft_downloads":131,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"fawereplace.zip","_minecraft_size_bytes":147719,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T19:01:06.015044Z","_minecraft_date_created":"2025-10-27T06:50:00.276647Z","_minecraft_date_modified":"2026-01-24T15:28:43.519945Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/fawereplace","_minecraft_icon_attachment_id":69531,"_minecraft_imported_at":"2026-06-03T23:06:57+00:00","_minecraft_import_hash":"0d8ee62d2d525191eb8544ce4ed834b3","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,127,128,129,159],"mod_loader":[130,132,133,134],"minecraft_version":[51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-69530","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-worldgen","mod_loader-bukkit","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n# Define which block types to replace
\n# IMPORTANT WARNING:
\n# X Do NOT replace common building blocks (like STONE, DIRT, WOOD, etc.)
\n# O Only replace blocks you want to clean (containers, machines, etc.)
\n#
\n# Format:
\n# – origin:
\n# target:
\n#
\n# Full material list:
\n# https:\/\/hub.spigotmc.org\/javadocs\/bukkit\/org\/bukkit\/Material.html<\/p>\n
\n – origin: SHULKER_BOX
\n target: AIR
\n – origin: YELLOW_SHULKER_BOX
\n target: AIR
\n – origin: GREEN_SHULKER_BOX
\n target: AIR
\n – origin: PURPLE_SHULKER_BOX
\n target: AIR
\n – origin: DISPENSER
\n target: AIR
\n – origin: ORANGE_SHULKER_BOX
\n target: AIR
\n – origin: FURNACE
\n target: AIR
\n – origin: BLACK_SHULKER_BOX
\n target: AIR
\n – origin: LIME_SHULKER_BOX
\n target: AIR
\n – origin: HOPPER
\n target: AIR
\n – origin: GRAY_SHULKER_BOX
\n target: AIR
\n – origin: RED_SHULKER_BOX
\n target: AIR
\n – origin: LIGHT_BLUE_SHULKER_BOX
\n target: AIR
\n – origin: BREWING_STAND
\n target: AIR
\n – origin: BROWN_SHULKER_BOX
\n target: AIR
\n – origin: BARREL
\n target: AIR
\n – origin: CAMPFIRE
\n target: AIR
\n – origin: LIGHT_GRAY_SHULKER_BOX
\n target: AIR
\n – origin: TRAPPED_CHEST
\n target: AIR
\n – origin: DROPPER
\n target: AIR
\n – origin: WHITE_SHULKER_BOX
\n target: AIR
\n – origin: CHEST
\n target: AIR
\n – origin: SOUL_CAMPFIRE
\n target: AIR
\n – origin: BLUE_SHULKER_BOX
\n target: AIR
\n – origin: MAGENTA_SHULKER_BOX
\n target: AIR
\n – origin: PINK_SHULKER_BOX
\n target: AIR
\n – origin: CYAN_SHULKER_BOX
\n target: AIR
\n – origin: BLAST_FURNACE
\n target: AIR
\n – origin: SMOKER
\n target: AIR<\/p>\n
\n# Remove specified entity types
\n# !Note:
\n# – Use carefully! May remove players’ items, mobs, etc.
\n# – Recommend testing on a test server first<\/p>\n
\n # Enable entity cleanup
\n enabled: false
\n # Full list:
\n # https:\/\/hub.spigotmc.org\/javadocs\/bukkit\/org\/bukkit\/entity\/EntityType.html
\n #
\n types: []
\n # Examples:
\n # – ITEM # Remove dropped items
\n # – ZOMBIE # Remove zombies
\n # – ARMOR_STAND # Remove armor stands
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"