Add readme
This commit is contained in:
Jesse Boyd
parent
783efb73b9
commit
1b2fec8e09
47
README.md
47
README.md
|
|
@ -1,34 +1,31 @@
|
|||
|
||||
=========
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/Fog5fDB.png">
|
||||
</p>
|
||||
|
||||
WorldEdit is Minecraft mod that turns Minecraft into an in-game map editor (sorta, kinda).
|
||||
---
|
||||
|
||||
* Make awesome stuff with half the time OR make ***quadriply** awesome* creations with the same time :sparkles:
|
||||
* Get lost in hundreds of options and functions that even we've forgotten existed
|
||||
* Utilize Photoshop-like tools like "selection areas" and "brushes"
|
||||
* Making fjords and other natural wonders with weird names
|
||||
* Also: fix grief, broken water, missing snow, raging fires, and other :poop:
|
||||
FAWE is a fork of WorldEdit that has huge speed and memory improvements and considerably more features
|
||||
|
||||
WorldEdit is open source!, so if you've just learned how to make a button blink, I probably recommend picking up a book on CS algorithms. The project is licensed using the GNU Lesser General Public License license, v3.
|
||||
It is available for Bukkit, Forge, Sponge and Nukkit.
|
||||
|
||||
Compiling
|
||||
---------
|
||||
## Chat
|
||||
### - **`> `**[`Discord`](https://discord.gg/ngZCzbU)`|`[`IRC`](http://webchat.esper.net/?nick=&channels=IntellectualCrafters)` | `[`Spigot Forums`](https://www.spigotmc.org/threads/fast-async-worldedit.100104/)**` <`**
|
||||
|
||||
See [COMPILING.md](COMPILING.md) for a guide on compiling WorldEdit.
|
||||
## Releases
|
||||
|
||||
Contributing
|
||||
------------
|
||||
### - [**`> Download <`**](https://empcraft.com/fawe/download/)
|
||||
### - [**`> Jenkins <`**](https://ci.athion.net/job/FastAsyncWorldEdit/)
|
||||
|
||||
We happily accept contributions, especially through pull requests on GitHub.
|
||||
Submissions must be licensed under the GNU Lesser General Public License v3.
|
||||
## Building
|
||||
FAWE uses gradle to build
|
||||
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for important guidelines to follow.
|
||||
```
|
||||
$ gradlew setupDecompWorkspace
|
||||
$ gradlew build
|
||||
```
|
||||
|
||||
Links
|
||||
-----
|
||||
|
||||
* [Visit our website](http://www.enginehub.org/)
|
||||
* [IRC channel](http://skq.me/irc/irc.esper.net/sk89q/) (#sk89q on irc.esper.net)
|
||||
* [Issue tracker](http://youtrack.sk89q.com/issues/WORLDEDIT)
|
||||
* [Continuous integration](http://builds.enginehub.org) [](https://travis-ci.org/sk89q/WorldEdit)
|
||||
* [End-user documentation](http://wiki.sk89q.com/wiki/WorldEdit)
|
||||
## Contributing
|
||||
Have an idea for an optimization, or a cool feature?
|
||||
- I'll accept most PR's
|
||||
- Let me know what you've tested / what may need further testing
|
||||
- If you need any help, create a ticket or discuss on Discord
|
||||
|
|
|
|||
|
|
@ -1,145 +0,0 @@
|
|||
#
|
||||
# WorldEdit's Configuration File
|
||||
#
|
||||
# About editing this file:
|
||||
# - DO NOT USE TABS. You MUST use spaces or Bukkit will complain and post
|
||||
# errors. If you use an editor, like Notepad++ (recommended for Windows
|
||||
# users), you must configure it to "replace tabs with spaces."
|
||||
# This can be changed in Settings > Preferences > Language Menu.
|
||||
# - Don't get rid of indentations. They are indented so some entries that are
|
||||
# in categories, like "max-blocks-changed", are placed in the "limits"
|
||||
# category.
|
||||
# - If you want to check the format of this file before putting it
|
||||
# into WorldEdit, paste it into http://yaml-online-parser.appspot.com/
|
||||
# and see if it gives you "ERROR:".
|
||||
# - Lines starting with # are comments, so they are ignored.
|
||||
# - If you want to allow blocks, make sure to change "disallowed-blocks" to []
|
||||
#
|
||||
|
||||
limits:
|
||||
allow-extra-data-values: false
|
||||
max-blocks-changed:
|
||||
default: -1
|
||||
maximum: -1
|
||||
max-polygonal-points:
|
||||
default: -1
|
||||
maximum: 20
|
||||
max-radius: -1
|
||||
max-super-pickaxe-size: 5
|
||||
max-brush-radius: 5
|
||||
butcher-radius:
|
||||
default: -1
|
||||
maximum: -1
|
||||
disallowed-blocks:
|
||||
- "minecraft:oak_sapling"
|
||||
- "minecraft:jungle_sapling"
|
||||
- "minecraft:dark_oak_sapling:"
|
||||
- "minecraft:spruce_sapling"
|
||||
- "minecraft:birch_sapling"
|
||||
- "minecraft:acacia_sapling"
|
||||
- "minecraft:black_bed"
|
||||
- "minecraft:blue_bed"
|
||||
- "minecraft:brown_bed"
|
||||
- "minecraft:cyan_bed"
|
||||
- "minecraft:gray_bed"
|
||||
- "minecraft:green_bed"
|
||||
- "minecraft:light_blue_bed"
|
||||
- "minecraft:light_gray_bed"
|
||||
- "minecraft:lime_bed"
|
||||
- "minecraft:magenta_bed"
|
||||
- "minecraft:orange_bed"
|
||||
- "minecraft:pink_bed"
|
||||
- "minecraft:purple_bed"
|
||||
- "minecraft:red_bed"
|
||||
- "minecraft:white_bed"
|
||||
- "minecraft:yellow_bed"
|
||||
- "minecraft:powered_rail"
|
||||
- "minecraft:detector_rail"
|
||||
- "minecraft:grass"
|
||||
- "minecraft:dead_bush"
|
||||
- "minecraft:moving_piston"
|
||||
- "minecraft:piston_head"
|
||||
- "minecraft:sunflower"
|
||||
- "minecraft:rose_bush"
|
||||
- "minecraft:dandelion"
|
||||
- "minecraft:poppy"
|
||||
- "minecraft:brown_mushroom"
|
||||
- "minecraft:red_mushroom"
|
||||
- "minecraft:tnt"
|
||||
- "minecraft:torch"
|
||||
- "minecraft:fire"
|
||||
- "minecraft:redstone_wire"
|
||||
- "minecraft:wheat"
|
||||
- "minecraft:potatoes"
|
||||
- "minecraft:carrots"
|
||||
- "minecraft:melon_stem"
|
||||
- "minecraft:pumpkin_stem"
|
||||
- "minecraft:beetroots"
|
||||
- "minecraft:rail"
|
||||
- "minecraft:lever"
|
||||
- "minecraft:redstone_torch"
|
||||
- "minecraft:redstone_wall_torch"
|
||||
- "minecraft:repeater"
|
||||
- "minecraft:comparator"
|
||||
- "minecraft:stone_button"
|
||||
- "minecraft:birch_button"
|
||||
- "minecraft:acacia_button"
|
||||
- "minecraft:dark_oak_button"
|
||||
- "minecraft:jungle_button"
|
||||
- "minecraft:oak_button"
|
||||
- "minecraft:spruce_button"
|
||||
- "minecraft:cactus"
|
||||
- "minecraft:sugar_cane"
|
||||
- "minecraft:bedrock"
|
||||
|
||||
use-inventory:
|
||||
enable: false
|
||||
allow-override: true
|
||||
creative-mode-overrides: false
|
||||
|
||||
logging:
|
||||
log-commands: false
|
||||
file: worldedit.log
|
||||
# The format of custom log message. This is java general format string (java.util.Formatter). Arguments are:
|
||||
# 1$ : date - a Date object representing event time of the log record.
|
||||
# 2$ : source - a string representing the caller, if available; otherwise, the logger's name.
|
||||
# 3$ : logger - the logger's name.
|
||||
# 4$ : level - the log level.
|
||||
# 5$ : message - the formatted log message returned from the Formatter.formatMessage(LogRecord) method. It uses java.text formatting and does not use the java.util.Formatter format argument.
|
||||
# 6$ : thrown - a string representing the throwable associated with the log record and its backtrace beginning with a newline character, if any; otherwise, an empty string.
|
||||
# For details see:
|
||||
# https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html
|
||||
# https://docs.oracle.com/javase/8/docs/api/java/util/logging/SimpleFormatter.html#format-java.util.logging.LogRecord-
|
||||
format: "[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS %4$s]: %5$s%6$s%n"
|
||||
|
||||
super-pickaxe:
|
||||
drop-items: true
|
||||
many-drop-items: false
|
||||
|
||||
snapshots:
|
||||
directory:
|
||||
|
||||
navigation-wand:
|
||||
item: minecraft:compass
|
||||
max-distance: 100
|
||||
|
||||
scripting:
|
||||
timeout: 3000
|
||||
dir: craftscripts
|
||||
|
||||
saving:
|
||||
dir: schematics
|
||||
|
||||
files:
|
||||
allow-symbolic-links: false
|
||||
|
||||
history:
|
||||
size: 15
|
||||
expiration: 10
|
||||
|
||||
wand-item: minecraft:wooden_axe
|
||||
shell-save-type:
|
||||
no-double-slash: false
|
||||
no-op-permissions: false
|
||||
debug: false
|
||||
show-help-on-first-use: true
|
||||
Loading…
Reference in New Issue