forked from EngineHub/WorldEdit
/
README.html
160 lines (157 loc) · 8.77 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html>
<head>
<title>WorldEdit ${version}</title>
<style>
body {
margin: 0;
padding: 20px;
background: #efefef;
color: #333;
}
#wrapper {
margin: 20px auto 20px auto;
width: 600px;
background: #fff;
padding: 40px;
border: 1px solid #fff;
border-radius: 10px;
-moz-border-radius: 10px;
-webkit-border-radius: 10px;
box-shadow: 0 0 2px #999;
-webkit-box-shadow: 0 0 3px #999;
}
a img {
border: 0;
}
body, th, td, input {
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>
<div id="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 <span class="optional">Optional</span>:</strong> Copy the "craftscripts/" folder into your root folder. These add additional functionality through JavaScript scripts. You also need to <a href="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 <a href="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 first add <strong>*</strong> to play with WorldEdit.</li>
</ol>
<h3>For Single Player Commands</h3>
<ol>
<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 <span class="optional">Optional</span>:</strong> Copy the "craftscripts/" folder into your ".minecraft" folder. These add additional functionality through JavaScript scripts. You also need to <a href="http://wiki.sk89q.com/wiki/WorldEdit/Installation/Single_player#Rhino">download and install Rhino</a> to use these.</li>
</ol>
<br>
<p>Be sure to:</p>
<ul>
<li>Subscribe to <a href="http://minecraftnews.sk89q.com/">SK's Minecraft blog</a> for news about WorldEdit</li>
<li>Submit bug reports and suggestions to the <a href="http://redmine.sk89q.com/projects/worldedit/issues">issue tracker</a></li>
<li>Check out the <a href="http://wiki.sk89q.com/wiki/WorldEdit">WorldEdit wiki</a></li>
<li>Download the accompanying (optional) <a href="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> Introduction</h2>
<p>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:</p>
<ul>
<li><strong>/jumpto</strong> sends you to the place that you are looking for</li>
<li><strong>/thru</strong> sends you through the wall that you are looking at</li>
<li><strong>/up #</strong> sends you upwards a certain number of blocks</li>
<li><strong>/ascend</strong> sends you up through the first block above you</li>
<li><strong>/descend</strong> sends you down through the floor</li>
</ul>
<p>However, you can also, using a <strong>compass</strong>, 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).</p>
<h2>Learning WorldEdit</h2>
<p>The best three ways to getting to know WorldEdit are:</p>
<ol>
<li>Print the <a href="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 <a href="http://wiki.sk89q.com/wiki/WorldEdit/Quick_start">quick start tutorial</a>. This guides you through the basic commands.</li>
<li>Check out <a href="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 <a href="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>
<p class="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>
<h2>Other Features</h2>
<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 <a href="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 <a href="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>
</ul>
<h3>Tools</h3>
<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 <a href="http://wiki.sk89q.com/wiki/WorldEdit/Tools">tools page</a>.</p>
<h2>Getting Help</h2>
<p>If you need help with WorldEdit, two good places to go are:</p>
<ul>
<li><a href="http://forum.sk89q.com/forums/worldedit.5/">WorldEdit forum</a></li>
<li>IRC on irc.esper.net on channel #worldedit</li>
</ul>
<h2>Contributing</h2>
<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><a href="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>
<p class="subtle">Maven information: ${groupId}/${artifactId}/${version}</p>
</div>
</body>
</html>