Configuration - SBPrime/AsyncWorldEdit-Premium GitHub Wiki

Back to main page

Rendering

This section contains parameters for configuring the block placer.

  • interval - number of ticks to wait between block drawing runs (for current bukkit version 1 tick = 1/20s)
  • talk-interval - how often the player should be informed of block placing progress (time in ticks = talk-interval * interval)
  • talk-cooldown - number of seconds to repeat the same message
  • queue-max-size-soft - the limit of blocks on the global queue until AWE allows adding new blocks after the queue-max-size-hard is reached.
  • queue-max-size-hard - maximum number of entries in AWE queue.

Memory

  • minimumHard - minumum free memory (in kilobytes) When the server memory runs below this value all operations are going to stop. Use -1 for no limit
  • minimumSoft - minumum free memory (in kilobytes) needed on the server after the hard limit is reached to allow new block queuing.
  • gcTimeout - force GC to run each X miliseconds (-1 - disable) when memory is low. Warning: if this is not handled correctly it can lead to TPS drop and timeouts!

Dispatcher

This section controls the task dispatcher. Since the dispatcher runs each tick it is important to configure it correctly.

  • max-jobs - maximum number of jobs the dispatcher can perform each run.
  • max-idle-runs - maximum number of idle runs before the dispatcher is stopped
  • max-time - maximum number of milliseconds the dispatcher can spend performing actions

Disabled operations

This section contains the list of WorldEdit functions that won't be run in async mode. For list of all supported operations enable debug mode, and reload the configuration (/awe reload config). The list of all operations will be displayed on the sever console.

Other

  • version - current config version, do not change
  • checkVersion - disable or enable checking if you are running the latest version
  • physicsFreez - enable the physics freeze when placing blocks (only in the edited area). Stops blocks from falling and liquids from flowing
  • strings - the messages file name
  • forceFlushBlocks - maximum number of blocks in queue mode before AWE forces block placing. Use -1 to disable force flush.

BlocksHub

Block change logging (log)

  • isEnabled - is the block change logging enabled enabled
  • isDcEnabled - is the block change logging enabled enabled for DirectChunk commands

Block access configuration (access)

  • isEnabled - is the access control enabled
  • allowNull - allow block placing for NULL players (usually bad plugin)
  • allowUnknown - allow block placing for Unknown Player (edits requested by other plugins)
  • allowConsole - allow block placing from Console (usually done by third party plugins)
  • allowOffline - allow block placing for offline players (in conflict with cleanOnLogout)

#Permissions

  • opHasAll - override the permission manager and give access to all permissions to OPs
  • disableQueueBypass - disable the global queue bypass. The player queue bypass ignores this option.

#Permission groups

  • permissionGroups - root node containing all the permission groups. All the groups need to by entered as child nodes of this one.
  • isDefault - is this group default. If a user does not have any AWE.Groups.x permission node this group is assigned. If a group does not define any of the group configuration parameters the default group entry value will by used.
  • maxJobs - maximum number of jobs the player can queue
  • cleanOnLogout - enable or disable auto cancelation of loging out player
  • defaultMode - the default mode of AWE plugin (on or off). If this is set to off AWE will by off for players until he/she executes the toggle on command.
  • disableUndo - disables the WorldEdit undo for the permission group

Renderer

  • blocks - number of blocks placed in each drawing package, use -1 for no limit
  • time - Maximum number of miliseconds spend on placing blocks, use -1 for no limit

##Queue

  • limit-hard - maximum number of blocks the player can queue. After this limit is reached the player can't draw blocks (until the queue size drops below queue-limit-soft).
  • limit-soft - the size the queue needs to drop below to allow player to draw blocks after reaching the queue-limit-hard.

##Messages

  • progress-bar - Use the BarAPI to display the progress
  • progress-bar-min - Minimum number of blocks on the queue to display the progress bar
  • progress-chat - Send text progress messages
  • talkative - enable or disable detailed messages send to the players

List of all WorldEdit operations:

  • undo
  • redo
  • fillXZ
  • removeAbove
  • removeBelow
  • removeNear
  • setBlocks
  • replaceBlocks
  • makeCuboidFaces
  • makeCuboidWalls
  • overlayCuboidBlocks
  • naturalizeCuboidBlocks
  • stackCuboidRegion
  • moveCuboidRegion
  • drainArea
  • fixLiquid
  • makeCylinder
  • makeSphere
  • makePyramid
  • thaw
  • simulateSnow
  • green
  • makePumpkinPatches
  • makeForest
  • makeShape
  • deformRegion
  • hollowOutRegion
  • paste
  • copy
  • cut
  • regenerate
  • center
  • drawLine
  • drawSpline
  • makeBiomeShape
  • forest
  • flora
  • setBiome
  • loadSchematic
  • saveSchematic
  • craftScript
  • makeFaces
  • makeWalls
  • overlayBlocks
  • naturalizeBlocks
  • stackRegion
  • moveRegion
  • schematicInfo
  • placeSchematic
  • chunkSet
  • chunkClear
  • chunkFill
  • chunkClone
  • chunkPaste
  • chunkCopy
  • chunkRelight
  • brush
  • smooth

Sample

awe:
  version: 12
  rendering:
    interval: 15
    talk-interval: 10
    talk-cooldown: 5
    queue-max-size-hard: 10000000
    queue-max-size-soft: 5000000
  memory:
    minimumHard: 200000
    minimumSoft: 400000
    gcTimeout: 10000
  dispatcher:      
    max-jobs: 2000
    max-idle-runs: 200
    max-time: 20
  forceFlushBlocks: 100000
  checkVersion: true
  physicsFreez: true
  strings: "english.yml"
  debug: false
  blocksHub:
    log:
      isEnabled: true
      isDcEnabled: false
    access:
      isEnabled: false
      allowNull: false
      allowUnknown: true
      allowConsole: true
      allowOffline: false     
  permissions:
    opHasAll: true
    disableQueueBypass: true        
  permissionGroups:
    default:
      isDefault: true
      maxJobs: 1
      cleanOnLogout: true
      defaultMode: on
      disableUndo: false
      renderer:
        blocks: 10000
        time: 40
      queue:
        limit-hard: 500000
        limit-soft: 250000
      messages:
        progress-bar: true
        progress-bar-min: 100
        progress-chat: true            
        talkative: true
    vip:
      isDefault: false 
      maxJobs: -1
      cleanOnLogout: false
      renderer:
        blocks: 2000
        time: 20
  disabledOperations:
    - drainArea
    - fixLiquid