font: 13px/17px "Lucida Grande", "Lucida Sans Unicode", Arial, Verdana, sans-serif;
}
a:link, a:visited {
color: #00688f;
text-decoration: underline;
}
a:hover, a:active {
color: #000;
border: 0;
}
h1 {
font: 170% "Trebuchet MS", Georgia, serif;
font-weight: bold;
color: #00428d;
margin: 15px 0 5px 0;
}
h2 {
font: 130% "Trebuchet MS", Georgia, serif;
font-weight: bold;
color: #59006c;
margin: 50px 0 5px 0;
padding: 0 0 3px 0;
border-bottom: 1px solid #ccc;
}
h3 {
font: 110% "Trebuchet MS", Georgia, serif;
font-weight: bold;
color: #db0048;
margin: 30px 0 0 0;
padding: 0;
color: #999;
text-transform: uppercase;
}
.warning {
background: #fffedf;
padding: 8px;
border: 1px dashed #ccc;
border-radius: 4px;
-moz-border-radius: 4px;
-webkit-border-radius: 4px;
font-size: 90%;
}
.optional {
background: none repeat scroll 0 0 #FFE081;
border-radius: 3px 3px 3px 3px;
font-size: 80%;
font-weight: normal;
padding: 1px 4px;
}
.subtle {
color: #999;
}
</style>
</head>
<body>
<divid="wrapper">
<h1>WorldEdit ${version}</h1>
<p>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.</p>
<h2>First Steps</h2>
<h3>For Bukkit</h3>
<ol>
<li><strong>Install the plugin:</strong> Copy WorldEdit.jar into your Bukkit server's "plugins" directory. Create the folder if it doesn't exist.</li>
<li><strong>Install the bundled scripts <spanclass="optional">Optional</span>:</strong> Copy the "craftscripts/" folder into your root folder. These add additional functionality through JavaScript scripts. You also need to <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Installation/Bukkit#Rhino">download and install Rhino</a> to use these.</li>
<li><strong>Change the configuration:</strong> Run your server once (with WorldEdit) and then edit the config.yml file that is generated inside "plugins/WorldEdit". Use <em>/worldedit reload</em> in the console to reload the configuration.</li>
<li><strong>Setup permissions:</strong> Visit the WorldEdit wiki to <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Permissions">learn the permissions</a>. However, if you're new to WorldEdit, you may not know what permissions to give, so give <strong>worldedit.*</strong> to play with WorldEdit.</li>
<li><strong>Install Single Player Commands.</strong> Be sure to delete "META-INF" to prevent black screens from occuring.</li>
<li><strong>Install WorldEdit:</strong> Copy WorldEdit.jar into your ".minecraft/bin" folder. Do not put WorldEdit.jar into minecraft.jar.</li>
<li><strong>Install the bundled scripts <spanclass="optional">Optional</span>:</strong> Copy the "craftscripts/" folder into your ".minecraft" folder. These add additional functionality through JavaScript scripts. You also need to <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Installation/Single_player#Rhino">download and install Rhino</a> to use these.</li>
</ol>
<p>Be sure to:</p>
<ul>
<li>Submit bug reports and suggestions to the <ahref="http://redmine.sk89q.com/projects/worldedit/issues">issue tracker</a></li>
<li>Check out the <ahref="http://wiki.sk89q.com/wiki/WorldEdit">WorldEdit wiki</a></li>
<li>Download the accompanying (optional) <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Client_addon">client-side addon</a> that lets WorldEdit draw lines onto your world (making things much easier!)</li>
</ul>
<h2>Learning WorldEdit</h2>
<p>The best three ways to getting to know WorldEdit are:</p>
<ol>
<li>Print the <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Printable_reference">reference guide</a> first and foremost. It contains a listing of all WorldEdit commands and allows you to quickly look up a command.</li>
<li>Read the <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Quick_start">quick start tutorial</a>. This guides you through the basic commands.</li>
<li>Check out <ahref="http://wiki.sk89q.com/wiki/WorldEdit">the wiki</a>. The wiki is the definitive reference for all commands. It contains verbose information about commands and provides warning information.</li>
</ol>
<p>Additionally, some users have made some <ahref="http://wiki.sk89q.com/wiki/WorldEdit#Video_tutorials">introductory videos</a>.</p>
<p>Remember that <strong>WorldEdit has a history</strong>. Use <strong>//undo</strong> to undo and <strong>//redo</strong> to redo. If you have limited RAM, be sure to clear your history with <strong>/clearhistory</strong> after large operations.</p>
<pclass="warning"><strong>Warning:</strong> The history in the Bukkit version of WorldEdit is reliable, but in Single Player Commands, not all commands can be undone!</p>
<p>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:</p>
<h3>Snapshots</h3>
<p>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 <strong>//restore</strong> 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 <em>reverse restore</em>. See <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Snapshots">snapshots</a>.</p>
<h3>Scripting</h3>
<p>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 <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Scripting">scripting information page</a>.</p>
<p>Some example scripts include:</p>
<ul>
<li>draw.js turns images into cloth blocks</li>
<li>maze.js generates mazes</li>
<li>roof.js creates pyramids to cover a region</li>
<p>WorldEdit has "tools" that you can "bind" to an item that you are holding. You can, for example, bind the <strong>/repl wood</strong> 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 <strong>/tree</strong> tool to generate trees instantly. See the <ahref="http://wiki.sk89q.com/wiki/WorldEdit/Tools">tools page</a>.</p>
<p>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!</p>
<ul>
<li><ahref="https://github.com/sk89q/worldedit">Download WorldEdit code from GitHub</a></li>
</ul>
<p>The code is covered under the GNU General Public License v3.</p>
