diff --git a/contributing.md b/contributing.md index 28940e6..aad163c 100644 --- a/contributing.md +++ b/contributing.md @@ -14,16 +14,16 @@ This project uses a Maven-like directory structure... scriptcraft + ScriptCraftPlugin.java - javascript + - lib + - (core javascript code goes here. Modules in this directory - should not be 'require'd by plugin or module authors) - modules + - (this is where module authors should put modules for - use by others) - plugins + - (this is where plugins - scriptcraft extensions for use by - operators and players should go) + js + + lib + + (core javascript code goes here. Modules in this directory + should not be 'require'd by plugin or module authors) + modules + + (this is where module authors should put modules for + use by others) + plugins + + (this is where plugins - scriptcraft extensions for use by + operators and players should go) resources + plugin.yml docs + @@ -71,6 +71,14 @@ called `greet.js` located in the plugins folder... global. Anyone with operator privileges can type `/js greet(self)` at the in-game command prompt to execute the function. +## Coding Conventions + +See for a recommended +approach to writing javascript code for ScriptCraft. ScriptCraft is +aimed at younger programmers so readability is important - moreso than +cleverness. If submitting new code for inclusion in ScriptCraft please +ensure it is documented using the guidelines below... + ## Documentation contributions The Young persons guide to programming source file is located at