From d06127cc841b7b44302ca636283b0debb2603904 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 17 Oct 2022 11:28:13 +0000 Subject: [PATCH] Merge pull request #889 from Andre601/wiki [wiki] Add new page for using placeholders --- Home.md | 1 + Using-Placeholders.md | 35 ++++++++++++++++++ _Sidebar.md | 1 + .../.github/workflows/push_to_wiki.yml | 0 .../Commands.md | 0 .../Common-Issues.md | 0 .../Expansion-cloud.md | 0 .../FAQ.md | 0 .../Home.md | 1 + .../Hook-into-PlaceholderAPI.md | 0 .../PlaceholderExpansion.md | 0 .../Placeholders.md | 0 .../Plugins-using-PlaceholderAPI.md | 0 .../_Footer.md | 0 .../_Sidebar.md | 1 + .../img/icon.png | Bin .../img/papi-logo.png | Bin .../img/readme/create-pr.png | Bin .../img/readme/fork.png | Bin .../img/readme/needs-update.png | Bin .../img/readme/new-branch.png | Bin .../img/readme/pr-prompt.png | Bin .../img/readme/select-branch.png | Bin .../img/readme/up-to-date.png | Bin .../img/wiki-logo.png | Bin ...a6d70cf97007835809db1a3d1ee1d55d39744c.txt | 0 26 files changed, 39 insertions(+) create mode 100644 Using-Placeholders.md rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/.github/workflows/push_to_wiki.yml (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Commands.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Common-Issues.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Expansion-cloud.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/FAQ.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Home.md (98%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Hook-into-PlaceholderAPI.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/PlaceholderExpansion.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Placeholders.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/Plugins-using-PlaceholderAPI.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/_Footer.md (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/_Sidebar.md (98%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/icon.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/papi-logo.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/create-pr.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/fork.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/needs-update.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/new-branch.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/pr-prompt.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/select-branch.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/readme/up-to-date.png (100%) rename {temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8 => temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c}/img/wiki-logo.png (100%) rename temp_wiki_excluded_018a8c0a9961ef0d35a5ca7af83940b14f513ac8.txt => temp_wiki_excluded_eca6d70cf97007835809db1a3d1ee1d55d39744c.txt (100%) diff --git a/Home.md b/Home.md index 489ec8c..808f06c 100644 --- a/Home.md +++ b/Home.md @@ -5,6 +5,7 @@ This wiki gives you information on how to create placeholders in your plugin tha It also has a list with all available placeholders (Work in progress). ### Setup +**[[Using Placeholders]]** **[[Hook into PlaceholderAPI]]** - [[First steps|Hook-into-PlaceholderAPI#first-steps]] - [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]] diff --git a/Using-Placeholders.md b/Using-Placeholders.md new file mode 100644 index 0000000..16491ff --- /dev/null +++ b/Using-Placeholders.md @@ -0,0 +1,35 @@ +This page is intended for server owners or server staff who want to learn how to use placeholders in a plugin. + +If you're a developer and would like to learn how to provide placeholders or support placeholders from other plugins in your own, check out [[Hook into PlaceholderAPI]]. + +## Prerequisites +Before you can use placeholders should you check a few things first. + +### Plugin supports PlaceholderAPI +The first and most important thing is, to find out if the plugin you want to use placeholders in is actually supporting PlaceholderAPI. +Chat-plugins such as EssentialsXChat do not natively support PlaceholderAPI and instead require separate plugins to "inject" the parsed placeholders into the final chat message. + +One way to check, if a Plugin is supporing PlaceholderAPI, is to check the [[Plugins using PlaceholderAPI]] page. +If the plugin is listed and if the `Supports placeholders` text has a check, does it mean that PlaceholderAPI support is available. + +If the plugin isn't listed, can you usually check its plugin page, or any other source of information, such as a wiki, for clues on if PlaceholderAPI is supported. + +### Proper Internet connection +PlaceholderAPI connects towards an eCloud located under https://api.extendedclip.com to retrieve information about placeholder expansions, but also to download said expansions from it. +Make sure that your server is allowing external connections to the above URL. If it doesn't, and you're using a host, contact their support and ask them to whitelist this URL. + +## Download/Get Expansion +The way PlaceholderAPI's system works, allows a Placeholder Expansion and its corresponding placeholders to either be included within a plugin (If placeholder requires said plugin) or to be available as a separate jar file on the eCloud of PlaceholderAPI. +Depending on what type you have, will you need to do some extra steps to use the placeholder from the Placeholder Expansion. + +One way to find out, if an Expansion is included or separate, is to check the [[Placeholders]] page for any entry of it. +If it exists on the page, can you check, if the line right after the title says `NO DOWNLOAD COMMAND` or `/papi ecloud download ...` (i.e. `/papi ecloud download Player`). + +If the line says the former, does it mean, the expansion is part of the plugin and doesn't need any extra steps to be active (Unless the plugin author mentions otherwise). +In the case of the later, will you need to download the expansion from the eCloud. Simply copy the command and execute it either in the console, or in-game. Afterwards, reload PlaceholderAPI using `/papi reload`. + +You can check what expansions are loaded by running `/papi list`. + +## Use Expansion +Using the placeholders of the Expansion is a straigh forward process. +Simply put the right placeholder format (i.e. `%player_name%`) inside whatever configuration option supports it. Please refer to any manuals or wikis a plugin may offer about what options support placeholders. diff --git a/_Sidebar.md b/_Sidebar.md index 30ad2cb..dccd719 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -5,6 +5,7 @@ **[[Main page|Home]]** ### Setup +**[[Using Placeholders]]** **[[Hook into PlaceholderAPI]]** - [[First steps|Hook-into-PlaceholderAPI#first-steps]] - [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]] diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/.github/workflows/push_to_wiki.yml b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/.github/workflows/push_to_wiki.yml similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/.github/workflows/push_to_wiki.yml rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/.github/workflows/push_to_wiki.yml diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Commands.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Commands.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Commands.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Commands.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Common-Issues.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Common-Issues.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Common-Issues.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Common-Issues.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Expansion-cloud.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Expansion-cloud.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Expansion-cloud.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Expansion-cloud.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/FAQ.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/FAQ.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/FAQ.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/FAQ.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Home.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Home.md similarity index 98% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Home.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Home.md index 489ec8c..808f06c 100644 --- a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Home.md +++ b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Home.md @@ -5,6 +5,7 @@ This wiki gives you information on how to create placeholders in your plugin tha It also has a list with all available placeholders (Work in progress). ### Setup +**[[Using Placeholders]]** **[[Hook into PlaceholderAPI]]** - [[First steps|Hook-into-PlaceholderAPI#first-steps]] - [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]] diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Hook-into-PlaceholderAPI.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Hook-into-PlaceholderAPI.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Hook-into-PlaceholderAPI.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Hook-into-PlaceholderAPI.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/PlaceholderExpansion.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/PlaceholderExpansion.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/PlaceholderExpansion.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/PlaceholderExpansion.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Placeholders.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Placeholders.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Placeholders.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Placeholders.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Plugins-using-PlaceholderAPI.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Plugins-using-PlaceholderAPI.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/Plugins-using-PlaceholderAPI.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/Plugins-using-PlaceholderAPI.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/_Footer.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/_Footer.md similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/_Footer.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/_Footer.md diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/_Sidebar.md b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/_Sidebar.md similarity index 98% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/_Sidebar.md rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/_Sidebar.md index 30ad2cb..dccd719 100644 --- a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/_Sidebar.md +++ b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/_Sidebar.md @@ -5,6 +5,7 @@ **[[Main page|Home]]** ### Setup +**[[Using Placeholders]]** **[[Hook into PlaceholderAPI]]** - [[First steps|Hook-into-PlaceholderAPI#first-steps]] - [[Adding placeholders to PlaceholderAPI|PlaceholderExpansion]] diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/icon.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/icon.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/icon.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/icon.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/papi-logo.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/papi-logo.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/papi-logo.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/papi-logo.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/create-pr.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/create-pr.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/create-pr.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/create-pr.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/fork.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/fork.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/fork.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/fork.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/needs-update.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/needs-update.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/needs-update.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/needs-update.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/new-branch.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/new-branch.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/new-branch.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/new-branch.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/pr-prompt.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/pr-prompt.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/pr-prompt.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/pr-prompt.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/select-branch.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/select-branch.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/select-branch.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/select-branch.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/up-to-date.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/up-to-date.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/readme/up-to-date.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/readme/up-to-date.png diff --git a/temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/wiki-logo.png b/temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/wiki-logo.png similarity index 100% rename from temp_wiki_018a8c0a9961ef0d35a5ca7af83940b14f513ac8/img/wiki-logo.png rename to temp_wiki_eca6d70cf97007835809db1a3d1ee1d55d39744c/img/wiki-logo.png diff --git a/temp_wiki_excluded_018a8c0a9961ef0d35a5ca7af83940b14f513ac8.txt b/temp_wiki_excluded_eca6d70cf97007835809db1a3d1ee1d55d39744c.txt similarity index 100% rename from temp_wiki_excluded_018a8c0a9961ef0d35a5ca7af83940b14f513ac8.txt rename to temp_wiki_excluded_eca6d70cf97007835809db1a3d1ee1d55d39744c.txt