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:40:00 +00:00
parent f40034ab22
commit 7eea0c2530
1 changed files with 29 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,4 +1,32 @@
ScriptCraft
===========
A Minecraft mod that lets you build using Javascript
A Minecraft mod that lets you build using Javascript
Description
===========
The ScriptCraft mod lets you enter javascript commands at the in-game prompt.
To bring up the in-game prompt press the `/` key then type `js ` followed by any javascript statement.
E.g. `/js 1+1` will print 2.
ScriptCraft uses Rhino (The built-in javascript interpreter that comes with current versions of Java).
Unfortunately, due to the need to reobfuscate the Minecraft codebase , it is not possible to expose the entire
Minecraft Java API via Javascript as this goes against the current terms of use for MCP (Minecraft is not open source).
As of Dec 27 2012, the ScriptCraft mod includes just a few built-in objects and functions to make building easier.
* 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)
* getPlayerPos() - A function which returns the current position of the player.
* putBlock(x,y,z,blockId,metaData) - A function which lets you place a block anywhere
* 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.
Prerequisites
=============
You'll need to install the Minecraft Coder Pack and be comfortable installing a Minecraft Mod.
You can get the Minecraft Coder Pack here...
http://mcp.ocean-labs.de/index.php/Main_Page