SpigotMC-Mirrors/PlaceholderAPI
1
0
Fork 0
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI synced 2024-11-01 07:46:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #999 from PlaceholderAPI/feature/wiki-add-paper-plugin-example

Browse Source 
[Wiki] Add paper-plugin.yml example
This commit is contained in:
PiggyPiglet 2023-09-05 19:06:26 +08:00 committed by GitHub
commit 32c54bb456
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
Hook-into-PlaceholderAPI.md
View File

@ -56,27 +56,61 @@ 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**:
```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.here
softdepend: [PlaceholderAPI] # This is used, if your plugin works without PlaceholderAPI. - `plugin.yml`
``` ```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
# 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**:
```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.here
depend: [PlaceholderAPI] # If your plugin requires PlaceholderAPI, to work, use this. - `plugin.yml`
``` ```yaml
name: ExamplePlugin
version: 1.0
author: author
main: your.main.path.Here
# 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