From b0f8c6656489f12f2c72c17f469b4ea67fa53233 Mon Sep 17 00:00:00 2001 From: Walter Higgins Date: Thu, 27 Dec 2012 12:46:00 +0000 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5021505..a60a41d 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ Minecraft Java API via Javascript as this goes against the current terms of use As of Dec 27 2012, the ScriptCraft mod includes just a few built-in objects and functions to make building easier. + * help() - Brings up a short help message. + * load('path-to-script.js') - lets you load and execute any javascript source file. Calling load() with no parameters will bring up a File Chooser dialog. (In the context of script files, the $SCRIPT js variable will refer to the current script filename and $SCRIPTPATH refers to the directory in which the current script resides.) * player - the Player object - unfortunately this isn't currently useful as its properties are obfuscated. * world - The minecraft world object - again - all properties are currently obfuscated. * getMousePos() - A function which returns the current position of the cross-hairs (if a block is selected) @@ -22,7 +24,9 @@ As of Dec 27 2012, the ScriptCraft mod includes just a few built-in objects and * putSign(String[] texts, x,y,z,blockId, metaData) - A function which lets you place a sign. The above primitives can be used to create buildings which would otherwise be time-consuming to create manually. -It is highly recommended using the attached drone.js javascript module which provides a fluent API for building. +It is highly recommended using the attached drone.js javascript module which provides a fluent API for building. +The Javascript `Drone` class provides a much richer API which can be used to construct buildings. See the attached +`cottage.js` file for an example of how to load and use the `drone.js` module. Prerequisites =============