Skip to content
SBPrime edited this page Oct 13, 2014 · 32 revisions

Description

This plugin has only one function: eliminate the lag caused by the WorldEdit! This is done by replacing the WorldEdits session with an special asynchronous one. All the block drawing is done in packages. The package size and how often the blocks are drawn are configurable in the config. AsyncWorldEdit is not a reimplementation of WorldEdit! It attaches the original WorldEdit API and WorldEdit classes and tries to fix the lags. There fore you have access to all the WorldEdit operations, and all those operations work exactly like in the original WorldEdit. So basically you get the same commands, same permissions and the same experience. In addition to that if WorldEdit team releases a new feature, fixes a bug all you need to do is update WorldEdit and AWE will do its job as usual.

Installation

To install the plugin simply follow those steps:

  1. download and install WorldEdit
  2. download the plugin
  • If you are using WorldEdit 5.x you need to get AsyncWorldEdit 1.x
  • If you are using WorldEdit 6.x (nightly builds) you need to get AsyncWorldEdit 2.x
  1. to enable blocks loggin and blocks access control download BlocksHub
  2. restart server
  3. edit the config file
  4. restart server or do /AWE reload

Download

Check the release page.

Auto updates

This plugin does not provide auto update feature it only nags the server owner's when there's an update. To disable this feature set checkVersion to false in the config. Alternatively you can remove the AWE.admin.version permission node if you don't want to receive update information.

I'm still experiencing lag!

Read

Block loggers & Block access control

The enables logging of blocks placed by WorldEdit and can enforce block access. This is done using a special plugin called BlocksHub. To enable block logging (or block access control) you need to enable it in AWE config. This feature requires you to download, install and configure BlocksHub and then install any of the supported block loggers (access controllers).

New loggers and new access control plugins are going to by added directly to BlocksHub plugin.

Plugin X stopped working after installing AWE

My plugin hooks into WorldEdit's session factory, many other plugins do the same (mainly block loggers). The difference between my and other plugins is that my plugin makes sure its attached to WorldEdit's session factory. Since WorldEdit allows only one plugin to provide a session factory plugins that ust this feature of WorldEdit are in conflict and (probably) wont work properly. If you have a plugin that stopped working after installing AsyncWorldEdit and the plugin uses WorldEdit in some way send me a PM with the plugin name and version, I'll try to add a workaround into my plugin.

Plugin API

Full API is on my todo list. For now you can send me feature requests and suggestions in this github issue.

Commands

Commands page

Permissions

Permissions page

Old permissions page

Configuration

Configuration page

Dependencies

This plugin depends on:

BlocksHub - block login and blocks access

Other optional dependencies:

Like it? Test it!

If you are interested in this plugin you can test it on Kyle's server:

MC.DEADX.NET MC.DEADX.NET

MCStats

This plugin uses MCStats to gather statistics. It gathers only the standard stats gathered for most of MCStat's enabled plugins (for example: OS, Java version, CPU, country, plugin and server version). For details what exactly is gathered click on the graph below. To disable the stats you need to disable stats gathering for MCStats (set opt-out to true in plugins/PluginMetrics/config.yml). This disables all the stats gathering for all plugins that use the default MCStats.

Thank you for using this plugin.

Thank you!

Thank you

Finally I would like to thank all the people that helped me with the plugin:

  • First of all I would like to thank EDawg878 that took care of the plugin during my longer then expected absence...
  • Secondly I would like to thank RulingKyle1496 for asking if I could extract the package rendering system from MCPainter to a new plugin what prompted me to make AWE...
  • Also I would like to thank Lukeer31 for throwing ideas for new features and testing the plugin...
  • Finall I would like to thank Phudster and Magic for checking the project documentation
  • I would also like to thank many other people that send me feedback on the plugin

#Donate Programmer: "an organism that turns caffeine and pizza into software".

If you like you can buy me a pizza ;)

Donate

Clone this wiki locally