arg/scriptcraft
Archived
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Walter Higgins 2012-12-27 12:46:00 +00:00
parent 7eea0c2530
commit b0f8c66564
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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)
@ -23,6 +25,8 @@ As of Dec 27 2012, the ScriptCraft mod includes just a few built-in objects and
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.
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
=============