This repository has been archived by the owner on Sep 1, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
14 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,7 @@ | |
/builder/dub.json | ||
/builder/views | ||
/crash | ||
/plugins | ||
/plugins/*/ | ||
/resources | ||
/worlds | ||
/*.toml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |