configuration docs for issue #102

This commit is contained in:
walterhiggins 2014-01-14 23:01:20 +00:00
parent a4999745de
commit 963df1898c
2 changed files with 32 additions and 0 deletions

View file

@ -131,6 +131,23 @@ Contributing
If you would like to contribute source code and/or documentation changes please [read contributing.md][contrib] If you would like to contribute source code and/or documentation changes please [read contributing.md][contrib]
Configuration
=============
ScriptCraft is a Bukkit Plugin and uses the Bukkit Configuration
API. On first loading, ScriptCraft will create a config.yml file in
the plugins/scriptcraft/ directory. This file looks like this...
extract-js:
plugins: true
modules: true
lib: true
This file allows scriptcraft admins to turn on or off re-unzipping of the `modules`,
`plugins` and `lib` folders when deploying a new version of
scriptcraft. It's strongly recommended that the `lib` directory always
be set to true to get the latest core scriptcraft code . The modules
and plugins directories are optional and not part of scriptcraft core.
Further Reading Further Reading
=============== ===============

View file

@ -1,3 +1,18 @@
# 2014 01 14
Added config.yml file for configuration options. This file allows
scriptcraft admins to turn on or off re-unzipping of the modules,
plugins and lib folders when deploying a new version of
scriptcraft. It's strongly recommended that the lib directory always
be set to true to get the latest core scriptcraft code . The modules
and plugins directories are optional and not part of scriptcraft core.
The config.yml file looks like this...
extract-js:
plugins: true
modules: true
lib: true
# 2014 01 13 # 2014 01 13
Bug Fix: Make ScriptCraft work with Nashorn javascript engine bundled with Java 8 Bug Fix: Make ScriptCraft work with Nashorn javascript engine bundled with Java 8