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

fill-region

Browse source
This commit is contained in:
walterhiggins 2013-12-24 23:09:25 +00:00
parent 82c9b9c125
commit c6b600ae9f
1 changed files with 18 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/release-notes.md
View file

@ -5,7 +5,11 @@
### Modules in ScriptCraft ### Modules in ScriptCraft
ScriptCraft now has a simple module loading system. ScriptCraft now uses the [CommonJS module contract][cjsmod] - that is - the same module system used by Node.js. All of the javascript code which comes bundled with ScriptCraft has been modified so that it conforms to the CommonJS module system. ScriptCraft now has a simple module loading system. ScriptCraft now
uses the [CommonJS module contract][cjsmod] - that is - the same
module system used by Node.js. All of the javascript code which comes
bundled with ScriptCraft has been modified so that it conforms to the
CommonJS module system.
### What this means for plugins you've developed using ScriptCraft ### What this means for plugins you've developed using ScriptCraft
@ -17,16 +21,24 @@ If you have written plugins using a previous version of ScriptCraft then you hav
... Option 2 should be relatively straightforward if you follow these steps... ... Option 2 should be relatively straightforward if you follow these steps...
1. Copy your own custom plugins from the `js-plugins` directory to the new `scriptcraft/plugins` directory. 1. Copy your own custom plugins from the `js-plugins` directory to the new `scriptcraft/plugins` directory.
2. In your javascript code any functions, objects or variables which you want to expose for use by others should be exposed using the special `exports` variable. All other code within your .js files will now be private by default. See below for details on how CommonJS/Node.js modules work. 2. In your javascript code any functions, objects or variables which
you want to expose for use by others should be exposed using the
special `exports` variable. All other code within your .js files will
now be private by default. See below for details on how
CommonJS/Node.js modules work.
If you have any questions or concerns or need help converting your existing javascript plugin, contact please post questions on the [ScriptCraft forum][scforum] or open an issue on the [Github project][github] If you have any questions or concerns or need help converting your
existing javascript plugin, contact please post questions on the
[ScriptCraft forum][scforum] or open an issue on the [Github
project][github]
[github]: http://github.com/walterhiggins/ScriptCraft [github]: http://github.com/walterhiggins/ScriptCraft
[scforum]: https://groups.google.com/forum/?fromgroups=#!forum/scriptcraft---scripting-minecraft [scforum]: https://groups.google.com/forum/?fromgroups=#!forum/scriptcraft---scripting-minecraft
In ScriptCraft, files and modules are in one-to-one correspondence. As an example, foo.js In ScriptCraft, files and modules are in one-to-one correspondence. As
loads the module circle.js in the same directory. an example, foo.js loads the module circle.js in the same directory.
*ScriptCraft now uses the same module system as Node.js - see [Node.js Modules][njsmod] for more details.* *ScriptCraft now uses the same module system as Node.js - see [Node.js
Modules][njsmod] for more details.*
[njsmod]: http://nodejs.org/api/modules.html [njsmod]: http://nodejs.org/api/modules.html
[cjsmod]: http://wiki.commonjs.org/wiki/Modules/1.1.1 [cjsmod]: http://wiki.commonjs.org/wiki/Modules/1.1.1