mirror of
https://github.com/PlaceholderAPI/PlaceholderAPI
synced 2024-11-01 07:46:28 +01:00
Merge pull request #999 from PlaceholderAPI/feature/wiki-add-paper-plugin-example
[Wiki] Add paper-plugin.yml example
This commit is contained in:
commit
32c54bb456
@ -56,26 +56,60 @@ dependencies {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Set PlaceholderAPI as (soft)depend
|
### Set PlaceholderAPI as (soft)depend
|
||||||
Next step is to go to your plugin.yml and add PlaceholderAPI as a depend or softdepend, depending (no pun intended) on if it is optional or not.
|
Next step is to go to your plugin.yml or paper-plugin.yml and add PlaceholderAPI as a depend or softdepend, depending (no pun intended) on if it is optional or not.
|
||||||
|
|
||||||
**Example Softdepend**:
|
**Example Softdepend**:
|
||||||
|
|
||||||
|
- `plugin.yml`
|
||||||
```yaml
|
```yaml
|
||||||
name: ExamplePlugin
|
name: ExamplePlugin
|
||||||
version: 1.0
|
version: 1.0
|
||||||
author: author
|
author: author
|
||||||
main: your.main.path.here
|
main: your.main.path.Here
|
||||||
|
|
||||||
softdepend: [PlaceholderAPI] # This is used, if your plugin works without PlaceholderAPI.
|
# This sets PlaceholderAPI as an optional dependency for your plugin.
|
||||||
|
softdepend: [PlaceholderAPI]
|
||||||
|
```
|
||||||
|
- `paper-plugin.yml`
|
||||||
|
```yaml
|
||||||
|
name: ExamplePlugin
|
||||||
|
version: 1.0
|
||||||
|
author: author
|
||||||
|
main: your.main.path.Here
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
server:
|
||||||
|
PlaceholderAPI:
|
||||||
|
# Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin.
|
||||||
|
load: BEFORE
|
||||||
|
required: false
|
||||||
```
|
```
|
||||||
|
|
||||||
**Example Depend**:
|
**Example Depend**:
|
||||||
|
|
||||||
|
- `plugin.yml`
|
||||||
```yaml
|
```yaml
|
||||||
name: ExamplePlugin
|
name: ExamplePlugin
|
||||||
version: 1.0
|
version: 1.0
|
||||||
author: author
|
author: author
|
||||||
main: your.main.path.here
|
main: your.main.path.Here
|
||||||
|
|
||||||
depend: [PlaceholderAPI] # If your plugin requires PlaceholderAPI, to work, use this.
|
# This sets PlaceholderAPI as an optional dependency for your plugin.
|
||||||
|
depend: [PlaceholderAPI]
|
||||||
|
```
|
||||||
|
- `paper-plugin.yml`
|
||||||
|
```yaml
|
||||||
|
name: ExamplePlugin
|
||||||
|
version: 1.0
|
||||||
|
author: author
|
||||||
|
main: your.main.path.Here
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
server:
|
||||||
|
PlaceholderAPI:
|
||||||
|
# Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin.
|
||||||
|
load: BEFORE
|
||||||
|
required: true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Adding placeholders to PlaceholderAPI
|
## Adding placeholders to PlaceholderAPI
|
||||||
|
Loading…
Reference in New Issue
Block a user