Updated Home (markdown)
Jesse Boyd
parent
248ae73453
commit
262f06b005
101
Home.md
101
Home.md
|
|
@ -1,40 +1,73 @@
|
|||
#### FAWE is an addon for WorldEdit and has multiple benefits:
|
||||
- Remove lag by being fast (instead of slow)
|
||||
- Edits are asynchronously processed and executed in fragments so the server doesn't hang
|
||||
- Minimal memory footprint with compression, and an undo on disk that actually works
|
||||
- Various safety measures e.g. entity/blockstate limiting, low memory checks and region restrictions
|
||||
- New and useful functionality
|
||||
# `FastAsyncWorldEdit`
|
||||
|
||||
#### How do I install the plugin?
|
||||
- Download FAWE (above)
|
||||
- Optional Vault (if you have a permissions plugin and want toggles)
|
||||
- Optional BlocksHub (if you want to hook into block logging)
|
||||
- [**`> Installation guide <`**](https://github.com/boy0001/FastAsyncWorldedit/releases)
|
||||
- [**`> Chat with us on #IntellectualCrafters <`**](http://webchat.esper.net/?nick=&channels=IntellectualCrafters&fg_color=000&fg_sec_color=000&bg_color=FFF)
|
||||
- [**`> Find the source on GitHub <`**](https://github.com/boy0001/FastAsyncWorldedit)
|
||||
- `Development builds of this project can be acquired at the provided continuous integration server.
|
||||
These builds have not been approved by the BukkitDev staff. Use them at your own risk. `
|
||||
- [**`> Get the latest build from Jenkins <`**](http://ci.athion.net/job/FastAsyncWorldEdit/)
|
||||
|
||||
##### Configuration
|
||||
https://github.com/boy0001/FastAsyncWorldedit/wiki/Configuration
|
||||
##### Permissions
|
||||
https://github.com/boy0001/FastAsyncWorldedit/wiki/Permissions
|
||||
##### Commands
|
||||
https://github.com/boy0001/FastAsyncWorldedit/wiki/Commands
|
||||
## Overview:
|
||||
> FAWE is an addon for WorldEdit that drastically improves its performance and adds a lot of new functionality by replacing most of the core classes.
|
||||
|
||||
#### How fast is it?
|
||||
It varies depending on what you are doing. The block placer probably has an upwards limit of around 20,000,000 blocks per second (bps) if you ignore preprocessing, have the area already loaded, and have 65536 changes per chunk.
|
||||
In game you'll see around 5-10mbps with fastmode and 1-3mbps without. Enabling further compression, chunk waiting or history on disk will result in slower edits. More complex actions e.g. `//regen` will also be slower.
|
||||
## Features:
|
||||
- Incredibly fast, lag free and uses minimal memory
|
||||
- Support for protection plugins (see below)
|
||||
- Advanced per player limits and inventory settings
|
||||
- All commands and messages are [`translatable`](https://gist.github.com/boy0001/1b9aaa07b6e546721faa7307d4dd846b)
|
||||
- No setup web integration: [`http://empcraft.com/fawe`](http://empcraft.com/fawe)
|
||||
- Adds commands to [`change blocks in entire worlds`](https://github.com/boy0001/FastAsyncWorldedit/wiki/Commands#anvil-commands)
|
||||
- Fast built in [`logging and rollback`](https://github.com/boy0001/FastAsyncWorldedit/wiki/Commands#history-commands) (see below)
|
||||
- Instant copying of arbitrary size: `//lazycopy`
|
||||
- Adds a lot of powerful new [`brushes and tools`](https://github.com/boy0001/FastAsyncWorldedit/wiki/Commands#brushestools)
|
||||
- Adds a lot more [`mask`](https://github.com/boy0001/FastAsyncWorldedit/wiki/WorldEdit---FAWE-mask-list) functionality
|
||||
- Adds a lot more [`pattern`](https://github.com/boy0001/FastAsyncWorldedit/wiki/WorldEdit-and-FAWE-patterns) functionality
|
||||
- Adds edit [`transforms`](https://github.com/boy0001/FastAsyncWorldedit/wiki/Transforms)
|
||||
- Supports new file formats (Structure block, PNG, BD)
|
||||
- Adds commands for fixing or changing [`lighting`](https://github.com/boy0001/FastAsyncWorldedit/wiki/Commands#region-commands)
|
||||
- Allows WorldEdit to be used from console: `//jumpto world,0,0,0`
|
||||
- Fixes bugs in WorldEdit such as block rotation, pasting entities, etc.
|
||||
- Can load corrupt schematic files
|
||||
- Unlimited undo/redo with history/clipboard on disk
|
||||
|
||||
#### How large can an edit be:
|
||||
If you use fastmode or enable history on disk, there is no limit. Without enabling further compression it's probably about 10mb/million blocks.
|
||||
## Supported platforms
|
||||
> PC: SP/MP, MCPE: MP
|
||||
|
||||
#### How does FAWE speed up WorldEdit
|
||||
- The chunk object is modified directly, removing the overhead from the Bukkit API.
|
||||
- Physics updates are skipped
|
||||
- Lots of things are cached e.g. Mappings of block id to baseblock or recently accessed chunk data arrays
|
||||
- Custom relight algorithm performed at the chunk level which is a lot faster than relighting all placed blocks
|
||||
- Block changes are sent to the client with a chunk packet rather than a packet for each block
|
||||
- Skips various redundant checks e.g. blocks without any data skip data checks, blocks without nbt skip nbt checks etc
|
||||
- Up to 11 layers of redundant WorldEdit extents can be removed depending on the action you are performing
|
||||
- The queue can being making changes to the world while an edit is still in the preprocessing stage
|
||||
- CraftBukkit
|
||||
- Spigot
|
||||
- Paper
|
||||
- Thermos
|
||||
- Forge
|
||||
- Sponge
|
||||
- Nukkit
|
||||
|
||||
#### How does FAWE use less memory
|
||||
- Reducing the overhead also avoids unnecessary object creation
|
||||
- FAWE generally stores information in more compact forms e.g. An empty chest is represented as two bytes and then put into a compressed byte array instead of a BlockState with redundant nbt.
|
||||
- As Large edits will be dispatched during preprocessing, the whole thing will never need to be stored in memory all at once.
|
||||
## For developers: [See here](https://github.com/boy0001/FastAsyncWorldedit/wiki/API)
|
||||
> Async world manipulation, loading, lighting + examples.
|
||||
|
||||
## Region restrictions:
|
||||
> The following plugins are supported:
|
||||
|
||||
- WorldGuard
|
||||
- Towny
|
||||
- GriefPrevention
|
||||
- PreciousStones
|
||||
- Factions (mcore, uuid, one)
|
||||
- Residence
|
||||
- Regios
|
||||
- PlotSquared
|
||||
- PlotMe
|
||||
|
||||
> Disable in the config, or bypass with `/wea` or `fawe.bypass`
|
||||
|
||||
## Logging and Rollback
|
||||
> Enable `use-disk` and `use-database` in the `config.yml` to use the in built FAWE logging/rollback. Alternatively, the following third party plugins are supported with [BlocksHub](https://www.spigotmc.org/resources/blockshub.331/) installed.
|
||||
|
||||
- CoreProtect
|
||||
- LogBlock
|
||||
- Prism
|
||||
- HawkEye
|
||||
|
||||
> It is safe to give normal players access to FAWE rollback. To bypass logging use `//fast`
|
||||
|
||||
## Metrics
|
||||
[](http://www.mcstats.org/plugin/FastAsyncWorldEdit)
|
||||
Loading…
Reference in New Issue