This plugin has only one function: eliminate the lag caused by the WorldEdit! This is done by hooking into WorldEdit inners classes and replacing some of them with specially prepared classes. All WorldEdit operations are divided into two stages: preparation and block placing. The preparation phase is done in async thread and calculates the list of blocks that need to be changed. All the block placing in stage two 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.
READ THIS! Before you buy.
I can't make a payment... Some ppl reported that they can't make a payment directly from Spigot. If you have this problem you can send the money directly from your PayPal (for details send me a PM).
I paid for the plugin but can't download it... Currently all transactions are accepted and processed manually therefore it may take up to 24h before you'll get access to the plugin download. If the transaction is not "instant" (for example: from a bank account) I wait for the transaction to finish before I grant access to the plugin.
I send you an email... I do not answer emails send to my PayPal email. Contact me on the public forum or send me a PM.
My transaction got rejected. I will cancel (reject) all transactions that fit those criteria:
I accept the payments manually because sometimes the PayPal Spigot connection fails and I need to add the users manually.
Plugin recommended by:
The premium version
Starting from the 1'st of January 2018 the AsyncWorldEdit Premium and the free versions are again one software. All the changes and features added to the premium are now available for everyone.
Ok so wher's the cache? First and most important, you won't receive support for the free version. Basically your on your own. All the updates to the premium version will eventually be added to the free version (it might be days it might be weeks) after the premium release. First the changes will be available as source code. The JAR release for the free version might be released might not. It might skip some versions, it might be released the same day as the premium, it might be released after couple of weeks. The source code will be provided without compilation instructions and without DRM modules.
So what do I get when I buy the premium version? First thin, and most important, you will get support (starting from simple trouble shooting to help in working with the source code). Secondly you won't need to build the jar file by yourself, you will get a pre-build jar file. WARNING: You can download a jar file of the plugin only from the Premium download page, if you got it from other source it is an -Redacted- copy (providing downloads for the jar breaks the license).
Repository and project page
GitHub
I'm missing... (I need...)
If AsyncWorldEdit lacks a feature that you would like to have, that would make your work much easier send me a PM describing your needs.
Installation
To install the plugin simply follow those steps (steps 5-6 are optional):
Upgrading from older version:
If you are upgrading from an older version of AWE in most cases you don't need to do anything special. Although if you are using an old version that still has the injector you need to remove it. In addition its a good practice to remove the AWE bridge plugins (fund in /plugins/AsyncWorldEdit/plugins/) and the installed file.
Version before 3.6.0
To install the plugin simply follow those steps (steps 5-7 are optional):
Version before 3.3.0
To install the plugin simply follow those steps (steps 5-7 are optional):
To install the plugin simply follow those steps:
Error performing safe operation...
AsyncWorldEdit queues changed blocks in a async thread and then places them in packages. Since many WorldEdit operations need to acquire blocks from the map AsyncWorldEdit needs to get the blocks during the preparation phase (in async thread). Since almost none of the API calls should be called from async thread (its risky at most) AsyncWorldEdit checks if it can do the block get in a async thread. If it detects that it is not possible/not allowed it dispatches this to the main thread. Sometimes AWE is not able to detect that the operation is not allowed, this causes the operation to fail. AWE logs this fact in the log (Error performing safe operation) and does the operation using the dispatcher. If all the operations ware processed using the dispatcher you would experience a drasticall speed decrease. On the other hand it is not possible to be 100% sure that the get operation will not fail from async thread. To be 100% sure AWE would need to inject its own classes into Bukkit inner workings.
License
For the full license please go to this link
Issues
To report issues please use the Github (or the premium one here) issue tracker.
I'm still experiencing lag!
Read
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.
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.
WARNING: To enable Direct Chunk API and BlocksHub integration you need to enable it in the options.
How fast you can go?
Recently a thread has been started on spigotmc.org where you can show others how fast you can place blocks using AsyncWorldEdit. You can also use that thread for reference on how to configurate AsyncWorldEdit for you hardware specification.
The thread can be found here.
How many blocks can I queue?
All tests ware done in a controlled environment. Using the official spigot, only AWE and WE ware installed and there was 1 player on the server. The AWE config was not changed.
On a minimum server (512m) free memory ~200m I managed to queue up to 1 000 000 blocks. But after the queue reached 500 000 blocks TPS started to dropped drastically because of the garbage collector. Therefore I do not recommend to queue more then 500 000 blocks on a server that has 200m free ram.
On a server that had 1g ram, approximately ~700m free, I managed to queue up to 2 500 000 blocks. After the queue reached 2 000 000 blocks the TPS started dropping because of the garbage collector.
Adding additional ram resulted in increase of the maximum number of queued blocks approximately by 1 500 000 blocks for each 500m of additional free ram. When I disabled the blocks freeze function I managed to queue additional 20% blocks, (1 800 000 for each additional 500m of free ram).
Plugin X stopped working after installing AWE
If a plugin stopped working after installing AsyncWorldEdit please contact me. I'll try to help.
Plugins that use AsyncWorldEdit
If you are a plugin author and your plugin uses AWE API contact me I'll add your plugin to the list.
API
For API and Maven please to go to Github. You might also want to check: Plugin API
Roadmap
Roadmap
Commands
Commands page
Permissions
Permissions page
Configuration
Configuration page
Changelog
Configuration page
Dependencies
This plugin depends on:
BlocksHub - block login and blocks access
Other optional dependencies:
Progress display plugins:
READ THIS! Before you buy.
I can't make a payment... Some ppl reported that they can't make a payment directly from Spigot. If you have this problem you can send the money directly from your PayPal (for details send me a PM).
I paid for the plugin but can't download it... Currently all transactions are accepted and processed manually therefore it may take up to 24h before you'll get access to the plugin download. If the transaction is not "instant" (for example: from a bank account) I wait for the transaction to finish before I grant access to the plugin.
I send you an email... I do not answer emails send to my PayPal email. Contact me on the public forum or send me a PM.
My transaction got rejected. I will cancel (reject) all transactions that fit those criteria:
- you used a unverified PayPal account,
- you used a unregistered PayPal account,
I accept the payments manually because sometimes the PayPal Spigot connection fails and I need to add the users manually.
Plugin recommended by:
The premium version
Starting from the 1'st of January 2018 the AsyncWorldEdit Premium and the free versions are again one software. All the changes and features added to the premium are now available for everyone.
Ok so wher's the cache? First and most important, you won't receive support for the free version. Basically your on your own. All the updates to the premium version will eventually be added to the free version (it might be days it might be weeks) after the premium release. First the changes will be available as source code. The JAR release for the free version might be released might not. It might skip some versions, it might be released the same day as the premium, it might be released after couple of weeks. The source code will be provided without compilation instructions and without DRM modules.
So what do I get when I buy the premium version? First thin, and most important, you will get support (starting from simple trouble shooting to help in working with the source code). Secondly you won't need to build the jar file by yourself, you will get a pre-build jar file. WARNING: You can download a jar file of the plugin only from the Premium download page, if you got it from other source it is an -Redacted- copy (providing downloads for the jar breaks the license).
Repository and project page
GitHub
I'm missing... (I need...)
If AsyncWorldEdit lacks a feature that you would like to have, that would make your work much easier send me a PM describing your needs.
Installation
To install the plugin simply follow those steps (steps 5-6 are optional):
- download and install WorldEdit 7.1.0-Beta1 (or newer)
- buy the plugin on spigotmc.org
- download AsyncWorldEdit.jar
- install AsyncWorldEdit (the injector is no longer needed)
- (o) to enable blocks loggin and blocks access control download BlocksHub
- (o) the appropriate bridge for your progress display plugin (For example: if you want to use ActionBarAPI you need AsyncWorldEdit-ActionBarAPI)
- restart server
- edit the config file
- restart server or do /AWE reload
Upgrading from older version:
If you are upgrading from an older version of AWE in most cases you don't need to do anything special. Although if you are using an old version that still has the injector you need to remove it. In addition its a good practice to remove the AWE bridge plugins (fund in /plugins/AsyncWorldEdit/plugins/) and the installed file.
Version before 3.6.0
To install the plugin simply follow those steps (steps 5-7 are optional):
- download and install WorldEdit 6.1.2 (or newer)
- buy the plugin on spigotmc.org
- download AsyncWorldEdit.jar (for WorldEdit dev you need to download AsyncWorldEdit-dev.jar, you can find it on the version history. Go to version history and click "download" for on the latest dev version)
- install AsyncWorldEdit (the injector will install automatically)
- (o) to enable blocks loggin and blocks access control download BlocksHub
- (o) if you are using PlotMe older then 0.17 and want to enable the PlotMeFix got to plugins/AsyncWorldEdit/plugins and change AsyncWorldEdit-PlotMe*.jar.dis to AsyncWorldEdit-PlotMe*.jar. Use the jar that's for your PlotMe version!
- (o) if you want to use additional progress display plugins enable the appropriate bridge for your progress display plugin (For example: if you want to use ActionBarAPI you need AsyncWorldEdit-ActionBarAPI)
- restart server
- edit the config file
- restart server or do /AWE reload
Version before 3.3.0
To install the plugin simply follow those steps (steps 5-7 are optional):
- download and install WorldEdit
- buy the plugin on spigotmc.org
- download AsyncWorldEdit
- install AsyncWorldEdit and AsyncWorldEditInjector
- (o) to enable blocks loggin and blocks access control download BlocksHub
- (o) if you are using PlotMe older then 0.17 and want to enable the PlotMeFix put AsyncWorldEdit-PlotMe* in your plugins folder. Use the jar that's for your PlotMe version!
- (o) if you want to use additional progress display plugins put the appropriate bridge for your progress display plugin (For example: if you want to use ActionBarAPI you need AsyncWorldEdit-ActionBarAPI)
- restart server
- edit the config file
- restart server or do /AWE reload
To install the plugin simply follow those steps:
- download WorldEdit and WorldEdit Forge
- install WorldEdit into plugins folder
- install WorldEdit forge into mods folder
- download AsyncWorldEdit
- install AsyncWorldEditInjector into mods folder (do not put it into the plugins folder!)
- install AsyncWorldEdit into plugins folder (do not put it into the mods folder!)
- Follow the installation instruction from the regular version starting from p5.
Error performing safe operation...
AsyncWorldEdit queues changed blocks in a async thread and then places them in packages. Since many WorldEdit operations need to acquire blocks from the map AsyncWorldEdit needs to get the blocks during the preparation phase (in async thread). Since almost none of the API calls should be called from async thread (its risky at most) AsyncWorldEdit checks if it can do the block get in a async thread. If it detects that it is not possible/not allowed it dispatches this to the main thread. Sometimes AWE is not able to detect that the operation is not allowed, this causes the operation to fail. AWE logs this fact in the log (Error performing safe operation) and does the operation using the dispatcher. If all the operations ware processed using the dispatcher you would experience a drasticall speed decrease. On the other hand it is not possible to be 100% sure that the get operation will not fail from async thread. To be 100% sure AWE would need to inject its own classes into Bukkit inner workings.
License
For the full license please go to this link
Issues
To report issues please use the Github (or the premium one here) issue tracker.
I'm still experiencing lag!
Read
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.
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.
WARNING: To enable Direct Chunk API and BlocksHub integration you need to enable it in the options.
How fast you can go?
Recently a thread has been started on spigotmc.org where you can show others how fast you can place blocks using AsyncWorldEdit. You can also use that thread for reference on how to configurate AsyncWorldEdit for you hardware specification.
The thread can be found here.
How many blocks can I queue?
All tests ware done in a controlled environment. Using the official spigot, only AWE and WE ware installed and there was 1 player on the server. The AWE config was not changed.
On a minimum server (512m) free memory ~200m I managed to queue up to 1 000 000 blocks. But after the queue reached 500 000 blocks TPS started to dropped drastically because of the garbage collector. Therefore I do not recommend to queue more then 500 000 blocks on a server that has 200m free ram.
On a server that had 1g ram, approximately ~700m free, I managed to queue up to 2 500 000 blocks. After the queue reached 2 000 000 blocks the TPS started dropping because of the garbage collector.
Adding additional ram resulted in increase of the maximum number of queued blocks approximately by 1 500 000 blocks for each 500m of additional free ram. When I disabled the blocks freeze function I managed to queue additional 20% blocks, (1 800 000 for each additional 500m of free ram).
Plugin X stopped working after installing AWE
If a plugin stopped working after installing AsyncWorldEdit please contact me. I'll try to help.
Plugins that use AsyncWorldEdit
If you are a plugin author and your plugin uses AWE API contact me I'll add your plugin to the list.
API
For API and Maven please to go to Github. You might also want to check: Plugin API
Roadmap
Roadmap
Commands
Commands page
Permissions
Permissions page
Configuration
Configuration page
Changelog
Configuration page
Dependencies
This plugin depends on:
BlocksHub - block login and blocks access
Other optional dependencies:
Progress display plugins:
- ActionBarAPI
- BarAPI
- BountifulAPI
- TitleManager
- WelcomeTitle
- ActionMessager
