Configuration - SBPrime/AsyncWorldEdit GitHub Wiki

For old configuration page definition go here

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)
  • queue-max-size - maximum number of entries in AWE queue.

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

Enabled Operations

This section contains the list of WorldEdit functions that are handled by AsyncWorldEdit.

Other

  • version - current config version, do not change
  • checkVersion - disable or enable checking if you are running the latest version
  • plotMeFixEnabled - enable or disable the plotme mask fix
  • 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

BlocksHub

  • logBlocks - enable blocks logging using blocks hub
  • checkAccess - enable blocks access control using blocks hub

#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.

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-chat - Send text progress messages
  • talkative - enable or disable detailed messages send to the players

Sample

awe:
  version: 3
  rendering:
    interval: 15
    talk-interval: 10
    queue-max-size: 10000000
  dispatcher:      
    max-jobs: 2000
    max-idle-runs: 200
    max-time: 20
  checkVersion: true
  physicsFreez: true
  plotMeFixEnabled: true
  strings: "english.yml"
  blocksHub:
    logBlocks: true
    checkAccess: false
  permissionGroups:
    default:
      isDefault: true
      maxJobs: 1
      cleanOnLogout: true
      defaultMode: on
      renderer:
        blocks: 10000
        time: 40
      queue:
        limit-hard: 500000
        limit-soft: 250000
      messages:
        progress-bar: true
        progress-chat: true
        talkative: true
    vip:
      isDefault: false 
      maxJobs: -1
      cleanOnLogout: false
      renderer:
        blocks: 2000
        time: 20
  enabledOperations:
    - undo
    - redo
    - fillXZ
    - removeAbove
    - removeBelow
    - removeNear
    - setBlocks
    - replaceBlocks
    - makeCuboidFaces
    - makeCuboidWalls
    - overlayCuboidBlocks
    - naturalizeCuboidBlocks
    - stackCuboidRegion
    - moveCuboidRegion
    - drainArea
    - fixLiquid