This repository has been archived on 2021-07-14. You can view files and clone it, but cannot push or open issues or pull requests.
scriptcraft/src/main/js/readme.md

14 lines
875 B
Markdown
Raw Permalink Normal View History

# scriptcraft root directory
This directory contains the following subdirectories...
* lib - contains core scriptcraft modules and code.
* modules - contains modules for use by others
* plugins - contains plugins (modules which are automatically loaded and globally-namespaced at startup)
If you are a minecraft modder who wants to develop simple mods then the `plugins` location is where you should probably place your .js files.
If you are a minecraft modder who wants to develop more complex mods or provide an API for other modders, then modules intended for use by plugins (your own or others) should probably be placed in the `modules` directory.
The `lib` directory is reserved for use by ScriptCraft. If a module is considered essential for all, or adds significantly useful new functionality to ScriptCraft then it should be placed in the `lib` directory.