Skip to content

Commit d169f49

Browse files
committed
Updating Young Person's Guide to use SpigotMC and fixed missing/broken events helper calls.
1 parent 350230b commit d169f49

5 files changed

Lines changed: 1254 additions & 258 deletions

File tree

README.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Let's begin …
1+
## ScriptCraft - Modding Minecraft with Javascript
2+
23
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/walterhiggins/ScriptCraft?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
34

45
ScriptCraft lets you write Minecraft Mods using Javascript - a
@@ -20,7 +21,7 @@ files in a directory.
2021
then [Start Here][cda].
2122
* Watch some [demos][ytpl] of what you can do with ScriptCraft.
2223

23-
This is a simple mod in a file called greet.js in the scriptcraft/plugins directory …
24+
This is a simple mod in a file called greet.js in the scriptcraft/plugins directory:
2425

2526
```javascript
2627
function greet( player ) {
@@ -53,6 +54,7 @@ following Minecraft Server software:
5354

5455
[spigot]: http://www.spigotmc.org/
5556
[gs]: http://www.glowstone.net/
57+
[cm]: http://canarymod.net/
5658

5759
I recommend using SpigotMC because both CanaryMod and CraftBukkit are
5860
no longer being actively developed. The ScriptCraft mod also lets you
@@ -71,35 +73,38 @@ Minecraft.
7173
[cottage]: https://github.com/walterhiggins/ScriptCraft/tree/master/src/main/js/plugins/drone/contrib/cottage.js
7274
[temple]: https://github.com/walterhiggins/ScriptCraft/blob/master/src/main/js/plugins/drone/contrib/temple.js
7375
[bukkit]: http://dl.bukkit.org/
74-
[cm]: http://canarymod.net/
7576

7677
# Prerequisites
7778

78-
* You will need to have Java version 7 or later installed on your
79-
machine. Check the version by typing `java -version` at a command
80-
prompt.
81-
82-
* You will need to [install SpigotMC][spigot] on your
83-
machine. SpigotMC is a customized version of Minecraft Server that
84-
makes it easy to install plugins and customize Minecraft. You can
85-
[download the SpigotMC server here.][spigotdl]
79+
ScriptCraft is a Minecraft Server Mod which only works with Minecraft
80+
for Personal computers (Windows, Mac and Linux). It does not work with
81+
X-BOX, Playstation or WiiU versions of the game. You will need to have
82+
Java version 7 or later installed. Check the version by typing `java
83+
-version` at a command prompt.
8684

8785
# Installation
8886

89-
Before installing ScriptCraft you must first install SpigotMC which is a special version of Minecraft Server that makes it easy to customize the game.
87+
Before installing ScriptCraft you must first install SpigotMC which is
88+
a special version of Minecraft Server that makes it easy to customize
89+
the game.
9090

9191
## Installing and Running SpigotMC
9292

93-
Follow these steps to download and install SpigotMC on your machine.
93+
Follow these steps to download and install SpigotMC.
9494

9595
1. Download Spigot's [BuildTools.jar][spigotdl]
9696
2. Save the BuildTools.jar file to a new directory called spigotmc.
9797
3. Open a terminal (Mac and Linux) or command prompt (windows) window and type `java -jar BuildTools.jar`. This will kick off a long series of commands to "build" SpigotMC.
9898
4. When the build is done, there will be a new file beginning with `spigot` and ending in `.jar` in the spigotmc directory. Run this file by typing `java -jar spigot-1.10.2.jar` (it might not be that exact name - you can list files in the directory by typing `dir` (Windows) or `ls` (Mac and Linux).
9999
5. The server will start up then shut down very shortly afterwards. You'll need to edit a file called `eula.txt` - change `eula=false` to `eula=true` and save the file.
100100
6. Run the `java -jar spigot-1.10.2.jar` command again - this time the server will start up. Shut it down by typing `stop` at the server prompt.
101-
7. Download the [scriptcraft.jar][dl] plugin and save it to the `plugins` directory and restart the server by typing `java -jar spigot-1.10.2.jar`.
102-
9. At the server prompt type `js 1 + 1` and hit enter. The result `2` should be displayed.
101+
102+
## Installing ScriptCraft
103+
104+
Follow these steps to download and install ScriptCraft.
105+
106+
1. Download the [scriptcraft.jar][dl] plugin and save it to the `plugins` directory and restart the server by typing `java -jar spigot-1.10.2.jar`.
107+
2. At the server prompt type `js 1 + 1` and hit enter. The result `2` should be displayed.
103108

104109
Congratulations - you've just installed your Custom Minecraft Server and are ready to begin writing your first mod!
105110

@@ -116,7 +121,7 @@ username to the ops.txt file in your server directory.
116121
Launch the server, then launch the Minecraft client and create a new
117122
server connection. The IP address will be `localhost` . Once you've
118123
connected to your server and have entered the game, look at a
119-
ground-level block and type …
124+
ground-level block and type:
120125

121126
/js up().box( blocks.wool.black, 4, 9, 1 )
122127

@@ -156,12 +161,12 @@ To get started writing your own mod, take a look at some of the
156161
Because the SpigotMC API is open, all of the SpigotMC API is accessible
157162
via javascript once the ScriptCraft plugin is loaded. There are a
158163
couple of useful Java objects exposed via javascript in the
159-
ScriptCraft plugin …
164+
ScriptCraft plugin:
160165

161166
* `__plugin` – the ScriptCraft Plugin itself. This is a useful
162167
starting point for accessing other SpigotMC objects. The `__plugin`
163168
object is of type [org.bukkit.plugin.Plugin][api] and all
164-
of its properties and methods are accessible. For example … `js
169+
of its properties and methods are accessible. For example: `js
165170
__plugin.name` returns the plugin's name
166171
(JavaScript is more concise than the equivalent Java code:
167172
`__plugin.getName()` ).
@@ -192,7 +197,7 @@ If you would like to contribute source code and/or documentation changes please
192197

193198
ScriptCraft works with Bukkit Plugin and uses the Bukkit Configuration
194199
API. On first loading, ScriptCraft will create a config.yml file in
195-
the plugins/scriptcraft/ directory. This file looks like this …
200+
the plugins/scriptcraft/ directory. This file looks like this:
196201

197202
extract-js:
198203
plugins: true
@@ -229,7 +234,7 @@ programs and how to do the same thing in JavaScript.
229234

230235
I highly recommend the series of [tutorials provided by CoderDojo Athenry][cda].
231236

232-
Developer Chris Cacciatore has created some interesting tools using ScriptCraft …
237+
Developer Chris Cacciatore has created some interesting tools using ScriptCraft:
233238

234239
* [A wolf-bot][wb]
235240
* [L-Systems (Large-scale fractal structures in Minecraft)][ls]

0 commit comments

Comments
 (0)