From 27f079b11d90e77a50f92acf38a11e9e7af0d272 Mon Sep 17 00:00:00 2001 From: sk89q Date: Sun, 1 May 2011 13:27:46 -0700 Subject: [PATCH] Replaced README.txt with useful README.html. --- README.html | 154 ++++++++++++++++++++++++++++++++++ README.txt | 26 ------ src/main/assembly/default.xml | 2 +- 3 files changed, 155 insertions(+), 27 deletions(-) create mode 100644 README.html delete mode 100644 README.txt diff --git a/README.html b/README.html new file mode 100644 index 000000000..b2fa13f4d --- /dev/null +++ b/README.html @@ -0,0 +1,154 @@ + + + +WorldEdit ${version} + + + + +
+ +

WorldEdit ${version}

+

Thanks for choosing WorldEdit! WorldEdit provides you with powerful in-game map editing tools and it is an indispensable tool for both creative and survival play.

+

First Steps

+ +

For Bukkit

+
    +
  1. Install the plugin: Copy WorldEdit.jar into your Bukkit server's "plugins" directory. Create the folder if it doesn't exist.
    2. +
  2. Install the bundled scripts Optional: Copy the "craftscripts/" folder into your root folder. These add additional functionality through JavaScript scripts. You also need to download and install Rhino to use these.
    3. +
  3. Change the configuration: Run your server once (with WorldEdit) and then edit the config.yml file that is generated inside "plugins/WorldEdit". Use /worldedit reload in the console to reload the configuration.
    4. +
  4. Setup permissions: Visit the WorldEdit wiki to learn the permissions. However, if you're new to WorldEdit, you may not know what permissions to give, so first add * to play with WorldEdit.
    5. +
+

For Single Player Commands

+
    +
  1. Install Single Player Commands. Be sure to delete "META-INF" to prevent black screens from occuring.
    2. +
  2. Install WorldEdit: Copy WorldEdit.jar into your ".minecraft/bin" folder. Do not put WorldEdit.jar into minecraft.jar.
    3. +
  3. Install the bundled scripts Optional: Copy the "craftscripts/" folder into your ".minecraft" folder. These add additional functionality through JavaScript scripts. You also need to download and install Rhino to use these.
    4. +
+
+

Be sure to:

+ +

Introduction

+

WorldEdit is pretty powerful and it may take some time to fully grasp exactly what it can do, but fortunately, there's a comprehensive wiki and quick start guide to get you started. Before you get into that though, you may want to become familiar with WorldEdit's navigation aids:

+ +

However, you can also, using a compass, left click to move to the place that you are looking at, and right click to pass through the immediate wall (/jumpto and /thru, respectively).

+

Learning WorldEdit

+

The best three ways to getting to know WorldEdit are:

+
    +
  1. Print the reference guide first and foremost. It contains a listing of all WorldEdit commands and allows you to quickly look up a command.
    2. +
  2. Read the quick start tutorial. This guides you through the basic commands.
    3. +
  3. Check out the wiki. The wiki is the definitive reference for all commands. It contains verbose information about commands and provides warning information.
    4. +
+

Additionally, some users have made some introductory videos.

+

Remember that WorldEdit has a history. Use //undo to undo and //redo to redo. If you have limited RAM, be sure to clear your history with /clearhistory after large operations.

+

Warning: The history in the Bukkit version of WorldEdit is reliable, but in Single Player Commands, not all commands can be undone!

+

Other Features

+

WorldEdit is largely an in-game map editor where you define areas and modify them, but it has a lot of extra tools that many are unfamiliar with. Once you've mastered the core features, be sure to check out these extras:

+

Snapshots

+

Snapshots allow you to restore a cuboid from a backup (even from a .zip). The obvious way to use this is to select a damaged region and use //restore to load the region from a backup. However, sometimes you may want to rollback your world to an older backup but hook WorldEdit's snapshots to the corrupt world (in the opposite way), allowing you to reverse restore. See snapshots.

+

Scripting

+

Hate Java? Love JavaScript? WorldEdit has a scripting interface backed by JavaScript, allowing you to write scripts to generate terrain or to fix problems. WorldEdit comes bundled with a few scripts that can be found in the "craftscripts/" folder in the download. Check out the scripting information page.

+

Some example scripts include:

+ +

Tools

+

WorldEdit has "tools" that you can "bind" to an item that you are holding. You can, for example, bind the /repl wood tool so that every time you right click with, say for example, a wooden sword, the block you right click becomes wood. You can also use the /tree tool to generate trees instantly. See the tools page.

+

Contributing

+

WorldEdit is entirely open source! You can download all of the plugin code to learn from it, modify it for your own self, or even contribute back!

+ +

The code is covered under the GNU General Public License v3.

+

Maven information: ${groupId}/${artifactId}/${version}

+
+ + \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index 888db10c9..000000000 --- a/README.txt +++ /dev/null @@ -1,26 +0,0 @@ -WorldEdit ${project.version} -Copyright (c) 2010, 2011 sk89q -Licensed under the GNU General Public License v3 - -Introduction ------------- - -WorldEdit is a powerful in-game world manipulation plugin with -support for working with block data, copying and pasting regions, -undoing and redoing operations, loading and saving .schematic -files, and much more. - -For installation and usage help, see: -http://wiki.sk89q.com/wiki/WorldEdit - -Thanks ------- - -Thanks to the following individuals for their contributions to WorldEdit. - -- Erik Broes -- Gunther De Wachter -- Dean Ward -- angelsl -- winzjany -- toi \ No newline at end of file diff --git a/src/main/assembly/default.xml b/src/main/assembly/default.xml index 03805f40c..8d6571ceb 100644 --- a/src/main/assembly/default.xml +++ b/src/main/assembly/default.xml @@ -17,7 +17,7 @@ false - README.txt + README.html / true