dan/flying-squid
1
0
Fork 0
mirror of https://github.com/danbulant/flying-squid synced 2026-06-18 14:01:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
mhsjlw 2015-11-28 07:26:36 -05:00
parent f2889dd674
commit 96ef26a21b
1 changed files with 14 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/plugins/README.md
View file

@ -1,21 +1,20 @@
## Usage
Installing plugins
======================
Drag plugins in this folder.
It's as easy as drag-and-drop! Just follow the instructions!
## Installing plugins
1. Just drag it into the plugins folder!
## Creating Plugin
1) Create folder.
2) Create your index.js inside the folder.
3) `cd` to the folder and type `npm init` and follow instructions.
4) index.js should return in module.exports. player, server, or entity. All are optional.
5.1) If you don't have config/settings.json, create it and copy everything from config/default-settings.json inside.
5.2) Add into plugins `"plugin_name": {}`. Add any options you'd like.
1. Create folder
2. Create your `index.js` inside the folder
3. `cd` to the folder and type `npm init` and follow instructions
4. `index.js` should return in module.exports. player, server, or entity. All are optional
5.
* If you don't have config/settings.json, create it and copy everything from config/default-settings.json inside.
* Add into plugins `"plugin_name": {}`. Add any options you'd like.
## Publish plugin
Use `npm publish` and follow instructions.
Use `npm init` and `npm publish` and follow the given instructions.