Updated Configuration (markdown)

Configuration.md

@@ -1,10 +1,36 @@
 Here's a documented config.yml
+To reload fawe use the command: `/fawe`
 ```YML
-// The max volume allowed in an edit (admins with WEA bypass this)
+// These limits apply to anyone without fastmode/worldedit bypass enabled
-max-volume: 50000000
+limits:
-// If the memory usage is above this value, the plugin will cancel all non fastmode WorldEdits
+  // No permission is needed for the default. To grant someone a higher limit, give them fawe.limit.<group>
+  // If an edit exceeds these limits, it will cancel (completed up to it's current point)
+  default:
+    // Max number of block changes
+    max-changes: 5000000
+    // Number of times WorldEdit can check the block at a location
+    max-checks: 5000000
+    // Allowed brush iterations
+    max-iterations: 1000
+    // Max allowed entities (e.g. cows)
+    max-entities: 1337
+    // Number of times a change can fail (e.g. if the player can't access that region)
+    max-fails: 50000000
+    // Blockstates include Banner, Beacon, BrewingStand, Chest, CommandBlock, CreatureSpawner, Dispenser, Dropper, EndGateway, Furnace, Hopper, Jukebox, NoteBlock, Sign, Skull, Structure
+    max-blockstates: 1337
+
+// If region restrictions should be enabled (e.g. PlotSquared)
+// To be allowed to WorldEdit in a region users need fawe.<plugin>
+region-restrictions: true
+
+// The maximum used memory before fawe starts cancelling non-admin edits.
 max-memory-percent: 95
-// Blocked commands (if the command processor is enabled)
+// If fawe should try to prevent server crashes
+crash-mitigation: true
+
+// The command processor disables commands and can print some feedback to a user about why their edit failed
+command-processor: false
+require-selection-in-mask: false
 command-blacklist:
 - cs
 - .s
@@ -12,23 +38,30 @@ command-blacklist:
 - snapshot
 - delchunks
 - listchunks
-// Enables command blocking and iteration limits
+
-command-processor: false
+// Configure WorldEdit history (undo/redo)
-// If a selection must be within the players current mask (command processor must be enabled)
-require-selection-in-mask: false
-// Max number of iterations allowed to be applied to a brush
-max-iterations: 1000
-// The max entities allowed per edit (admins can bypass this)
-max-entities: 1337
-// The max blockstates (chests and such) allowed per edit (admins can bypass)
-max-blockstates: 1337
-// Crash mitigation will try to free up some memory when <1% is free
-crash-mitigation: true
-// If fawe should actively seek and fix bad lighting
-fix-all-lighting: true
 history:
-  // Slower, but compresses history for decreased memory usage
+  // Should history be saved on disk (frees up a lot of memory and persists restarts)
-  compress: false
-  // Stores the history on disk rather than in memory
   use-disk: false
+  // The buffer size used for the default history compression
+  buffer-size: 531441
+  // Should further compression be enabled? (Slower but can save a lot of memory)
+  compress: false
+  // The time in milliseconds to wait for a chunk to load for command preprocessing (50ms = 1 server tick)
+  chunk-wait-ms: 0
+
+// Configure the block placement queue
+queue:
+  // Increase or decrease queue intensity (0 = balance of performance / stability)
+  extra-time-ms: 0
+  // The time the queue can be idle before it is forced to start on edits which are still in the preprocessing stage
+  max-wait-ms: 1000
+  // Discard edits which have been idle for a certain amount of time (e.g. a plugin creates an EditSession but never does anything with it)
+  discard-after-ms: 60000
+  // If the global queue is above the target size, it will begin on edits still in the preprocessing stage
+  // FAWE is most efficient when edits have finished preprocessing, but larger edits may use too much memory to let them finish
+  target-size: 64
+
+// If all lighting should be fixed in a chunk that is edited
+fix-all-lighting: true
 ```