Skip to content
This repository has been archived by the owner on Sep 1, 2019. It is now read-only.

Commit

Permalink
Add plugins/README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kripth committed Sep 30, 2018
1 parent e817145 commit 8af436b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
/builder/dub.json
/builder/views
/crash
/plugins
/plugins/*/
/resources
/worlds
/*.toml
Expand Down
13 changes: 13 additions & 0 deletions plugins/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Plugins are a way to extend the functionality of Selery.
They are written in D (like Selery) and are compiled with the server.

## Structure

Plugins placed in the `plugins` folders are automatically compiled with Selery to create an executable file.

Every plugin must contain a `plugin.toml` file that indicates how and when compile the plugin.
The field are the following:
- `name`: Indicates the plugin's name. It must be unique on the server.
- `authors`: An array with the authors of the plugin.
- `target`: Whether the plugin is executed on the `hub` or on the `node`. Read the main README file for more informations about Selery's model.
- `main`: The main class of the plugin that must extend `HubPlugin` or `NodePlugin`.

0 comments on commit 8af436b

Please sign in to comment.