Merge pull request #1166 from PlaceholderAPI/feature/wiki-add-hytale-plugins-using-papi

[Wiki] Feature/wiki add hytale plugins using papi + more placeholders

.github/workflows/validate_site.yml

@@ -1,53 +0,0 @@
-name: "Validate Wiki Build"
-
-on:
-  pull_request_target:
-    types:
-      - opened
-      - reopened
-      - synchronize
-    paths-ignore:
-      - "README.md"
-    branches:
-      - wiki
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  issues: write
-
-env:
-  RUN_URL: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_number }}"
-
-jobs:
-  buildWiki:
-    runs-on: ubuntu-latest
-    steps:
-      - name: "Checkout Repository"
-        uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-          ref: "${{ github.event.pull_request.head.sha }}"
-      - name: "Setup Python 3.x"
-        uses: actions/setup-python@v6
-        with:
-          python-version: 3.x
-      - name: "Install dependencies"
-        run: "pip install -r requirements.txt"
-      - name: "Build Site"
-        run: "mkdocs build --strict"
-  commentOnFail:
-    runs-on: ubuntu-latest
-    if: ${{ failure() }}
-    steps:
-      - name: "Create Comment"
-        uses: peter-evans/create-or-update-comment@v5
-        with:
-          body: |-
-            ## Wiki Build failure
-
-            Something went wrong while creating a test-build of the Wiki for this Pull request.
-            Please check the [Workflow Logs](${{ env.RUN_URL }}) for any errors.
-          issue-number: "${{ github.event.pull_request.number }}"
-          token: "${{ secrets.GITHUB_TOKEN }}"
-          edit-mode: replace

docs/faq.md

@@ -29,7 +29,7 @@ When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse)
     It can happen that the plugin you use to display the placeholder in doesn't support PlaceholderAPI. In such a case check, if the parse command returns the actual value of a placeholder.  
     If that is the case while the plugin is still displaying the placeholder, can this be an indicator of the plugin not supporting PlaceholderAPI.
     
-    You can find a list of plugins supporting PlaceholderAPI [here](users/plugins-using-placeholderapi.md).  
+    You can find a list of plugins supporting PlaceholderAPI [here](users/plugins-using-placeholderapi/index.md).  
     Just make sure that "Supports placeholders" has a check mark in front of it.
   
 - ### No typo in the placeholder

docs/index.md

@@ -20,7 +20,7 @@ It also has a community-curated list of all available Placeholder expansions and
     - [:octicons-chevron-right-16: Commands](users/commands.md)  
     - [:octicons-chevron-right-16: Using Placeholders](users/using-placeholders.md)  
     - [:octicons-chevron-right-16: Placeholder List](users/placeholder-list/index.md)  
-    - [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md)
+    - [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi/index.md)
     
 -   ### :material-file-code: Dev Guides
     

docs/users/index.md

@@ -40,6 +40,6 @@ The pages listed under this section are meant for server owners who want to use
     
     List of Plugins that support PlaceholderAPI and/or provide their own placeholders to use.
     
-    - [:octicons-chevron-right-16: Go to Page](plugins-using-placeholderapi.md)
+    - [:octicons-chevron-right-16: Go to Page](plugins-using-placeholderapi/index.md)
 
 </div>

docs/users/placeholder-list/hytale.md

@@ -19,7 +19,7 @@ Further details on how to contribute to this list or the wiki as a whole can be
     - **B**
         - *No Expansions*
     - **C**
-        - *No Expansions*
+        - **[ChangeOutput](#changeoutput)**
     - **D**
         - *No Expansions*
     - **E**
@@ -79,13 +79,14 @@ Further details on how to contribute to this list or the wiki as a whole can be
     - **D**
         - *No Expansions*
     - **E**
-        - *No Expansions*
+        - **[EliteEssentials](#eliteessentials)**
     - **F**
         - *No Expansions*
     - **G**
         - *No Expansions*
     - **H**
-        - *No Expansions*
+        - **[HyFactions](#hyfactions)**
+        - **[HyVotifier](#hyvotifier)**
     - **I**
         - *No Expansions*
     - **J**
@@ -105,7 +106,7 @@ Further details on how to contribute to this list or the wiki as a whole can be
     - **Q**
         - *No Expansions*
     - **R**
-        - *No Expansions*
+        - **[RPGLevelling](#rpglevelling)**
     - **S**
         - *No Expansions*
     - **T**
@@ -115,7 +116,7 @@ Further details on how to contribute to this list or the wiki as a whole can be
     - **V**
         - *No Expansions*
     - **W**
-        - *No Expansions*
+        - **[WiFlowAPI](#wifloapi)**
     - **X**
         - *No Expansions*
     - **Y**
@@ -130,6 +131,38 @@ Further details on how to contribute to this list or the wiki as a whole can be
 Expansions listed here don't need any plugin/mod or extra library to function properly, unless mentioned otherwise.  
 A majority of these Expansions are maintained by the PlaceholderAPI team and can be considered *official*.
 
+----
+
+### **ChangeOutput**
+/// command | papi ecloud download changeoutput
+///
+
+Allows you to change the output based on what other placeholders return. 
+
+More information can be found on the [GitHub Repository](https://github.com/PlaceholderAPI/Expansion-ChangeOutput/tree/hytale)
+
+```
+%changeoutput_<options>_input:<input>_matcher:<matcher>_ifmatch:<output-if-matched>_else:<output-if-not-matched>%
+```
+
+- `<options>`
+- equals - match the input exactly
+- ignorecase - match the input while ignoring cases
+- ignorecolor - match the input while ignoring colour codes
+- contains - check if the match contains input
+- \>= - check if the input is larger than or equal to the matcher
+- \> - check if the input is larger than the matcher
+- <= - check if the input is less than or equal to the matcher
+- < - check if the input is less than the matcher
+- `<input>` - this is your text that you wish to replace
+- `<match>` - this is the text we will be looking for to meet the conditions
+- `<output-if-matched>` - if the input meets the condition, this text will be displayed
+- `<output-if-not-matched>` - if the input does not meet the condition, this text will be displayed instead
+
+*All arguments can be replaced with other placeholders, wrapped in* `{}`
+
+----
+
 ### **Player**
 /// command | papi ecloud download Player
 ///
@@ -253,6 +286,134 @@ Expansions listed here require the linked resource (plugin/mod) to work properly
 Most of the listed Expansions are NOT made and maintained by the PlaceholderAPI team.  
 Please see ?510 for a list of all expansions officially maintained by the PlaceholderAPI team.
 
+### **[EliteEssentials](https://www.curseforge.com/hytale/mods/eliteessentials)**
+/// integrated | Built into Plugin
+///
+
+```
+%eliteessentials_economy_enabled%
+%eliteessentials_using_external_economy%
+%eliteessentials_currency_name%
+%eliteessentials_currency_name_plural%
+%eliteessentials_currency_symbol%
+%eliteessentials_balance%
+%eliteessentials_god%
+%eliteessentials_vanished%
+%eliteessentials_homes_num%
+%eliteessentials_homes_max%
+%eliteessentials_homes_names%
+%eliteessentials_all_kits_num%
+%eliteessentials_all_kits_names%
+%eliteessentials_allowed_kits_num%
+%eliteessentials_allowed_kits_names%
+%eliteessentials_all_warps_num%
+%eliteessentials_all_warps_names%
+%eliteessentials_allowed_warps_num%
+%eliteessentials_allowed_warps_names%
+%eliteessentials_home_<name>_name%
+%eliteessentials_home_<name>_createdat%
+%eliteessentials_home_<name>_coords%
+%eliteessentials_home_<name>_x%
+%eliteessentials_home_<name>_y%
+%eliteessentials_home_<name>_z%
+%eliteessentials_home_<name>_yaw%
+%eliteessentials_home_<name>_pitch%
+%eliteessentials_home_<name>_world%
+%eliteessentials_kit_<id>_name%
+%eliteessentials_kit_<id>_id%
+%eliteessentials_kit_<id>_description%
+%eliteessentials_kit_<id>_icon%
+%eliteessentials_kit_<id>_cooldown%
+%eliteessentials_kit_<id>_remainingcooldown%
+%eliteessentials_kit_<id>_items%
+%eliteessentials_warp_<name>_name%
+%eliteessentials_warp_<name>_description%
+%eliteessentials_warp_<name>_permission%
+%eliteessentials_warp_<name>_createdat%
+%eliteessentials_warp_<name>_createdby%
+%eliteessentials_warp_<name>_coords%
+%eliteessentials_warp_<name>_x%
+%eliteessentials_warp_<name>_y%
+%eliteessentials_warp_<name>_z%
+%eliteessentials_warp_<name>_yaw%
+%eliteessentials_warp_<name>_pitch%
+%eliteessentials_warp_<name>_world%
+```
+
+----
+
+### **[HyFactions](https://www.curseforge.com/hytale/mods/hyfactions)**
+/// command | papi ecloud download HyFactions
+///
+
+Relational:
+```
+%rel_factions_relation% - Relation type (ally, enemy, etc)
+%rel_factions_relation_color% - green, white, red
+```
+
+Standard:
+```
+%factions_player_has_faction% - yes/no
+%factions_player_faction% - faction name
+%factions_player_faction_id% - faction uuid
+%factions_player_faction_rank% - rank in faction
+%factions_player_power% - power level of player
+%factions_party_color% - party color (number)
+%factions_party_name% - party name
+%factions_party_id% - party id
+%factions_party_description% - party description
+%factions_party_created% - date of party creation
+%factions_party_max_claims% - max number of claims for party
+%factions_party_claims% - number of claims by party
+%factions_party_members% - number of members in party
+%factions_party_owner_id% - owner uuid
+%factions_party_owner_name% - owner username
+%factions_faction_home_dimension% - dimension name of faction home
+%factions_faction_home_x% - 2 D.P. x coord of faction home
+%factions_faction_home_y% - 2 D.P. y coord of faction home
+%factions_faction_home_z% - 2 D.P. z coord of faction home
+%factions_faction_home_coords% - 2 D.P. x y z coords of faction home
+%factions_faction_home_yaw% - 2 D.P. yaw of faction home
+%factions_faction_home_pitch% - 2 D.P. pitch of faction home
+%factions_faction_color% - number of faction color
+%factions_faction_description% - faction description
+%factions_faction_max_claims% - max claims allowed by faction
+%factions_faction_owner_id% - faction owner uuid
+%factions_faction_owner_name% - faction owner username
+%factions_faction_created% - date of faction creation
+%factions_faction_members% - number of members in faction
+%factions_faction_relations% - number of relations with other factions
+%factions_faction_allies% - number of allies
+%factions_faction_neutrals% - number of neutrals
+%factions_faction_enemies% - number of enemies
+%factions_faction_claims% - number of claims by faction
+%factions_faction_total_power% - total power of faction
+```
+
+----
+
+### **[HyVotifier](https://www.curseforge.com/hytale/mods/hytale-votifier)**
+/// command | papi ecloud download HyVotifier
+///
+
+```
+%hyvotifier_offline_votes%
+%hyvotifier_has_offline_votes%
+%hyvotifier_offline_votes_enabled%
+%hyvotifier_offline_votes_maxclaims%
+%hyvotifier_offline_votes_maxlifetimehrs%
+%hyvotifier_milestones_enabled%
+%hyvotifier_milestone_votecount%
+%hyvotifier_next_milestone%
+%hyvotifier_leaderboard_votes%
+%hyvotifier_leaderboard_position%
+%hyvotifier_leaderboard_top_<position>_name% (replace <position> with any positive integer, e.g., 1, 2, 3, ...)
+%hyvotifier_leaderboard_top_<position>_votes% (replace <position> with any positive integer, e.g., 1, 2, 3, ...)
+```
+
+----
+
 ### **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
 /// command | papi ecloud download LuckPerms
 ///
@@ -281,3 +442,29 @@ Please see ?510 for a list of all expansions officially maintained by the Placeh
 %luckperms_inherited_expiry_time_<permission>%
 %luckperms_group_expiry_time_<groupname>%
 ```
+
+----
+
+### **[RPGLevelling](https://www.curseforge.com/hytale/mods/rpg-leveling-and-stats)**
+/// command | papi ecloud download RPGLevelling
+///
+
+```
+%rpglevelling_xp%
+%rpglevelling_level%
+%rpglevelling_is_max%
+%rpglevelling_maxlevel%
+%rpglevelling_xpnextlevel%
+```
+
+----
+
+### **[WiFlowAPI](https://www.curseforge.com/hytale/mods/wiflows-placeholderapi)**
+/// command | papi ecloud download WiFlowAPI
+///
+Lets you use placeholders from WiFlow's API
+A list of placeholders can be found [here](https://docs.wiflow.dev/hytale-plugins/wiflow-placeholderapi/expansions).
+```
+%wiflowapi_{placeholder}%
+```
+

docs/users/plugins-using-placeholderapi/hytale.md

@@ -0,0 +1,218 @@
+---
+description: List of Plugins that support PlaceholderAPI and/or provide their own placeholders to use.
+---
+
+# Hytale
+
+This here is a list of all plugins supporting the Hytale version of PlaceholderAPI by either having their own placeholders added, or just allowing other placeholders to be used.  
+If your plugin isn't shown here and you want it to be added, [read the Wiki README](https://github.com/PlaceholderAPI/PlaceholderAPI/blob/wiki/README.md) on how you can submit your changes.
+
+## Plugins
+
+- **[A](#a)**
+- **[B](#b)**
+- **[C](#c)**
+- **[D](#d)**
+- **[E](#e)**
+- **[F](#f)**
+- **[G](#g)**
+- **[H](#h)**
+- **[I](#i)**
+- **[J](#j)**
+- **[K](#k)**
+- **[L](#l)**
+- **[M](#m)**
+- **[N](#n)**
+- **[O](#o)**
+- **[P](#p)**
+- **[Q](#q)**
+- **[R](#r)**
+- **[S](#s)**
+- **[T](#t)**
+- **[U](#u)**
+- **[V](#v)**
+- **[W](#w)**
+- **[X](#x)**
+- **[Y](#y)**
+- **[Z](#z)**
+
+----
+## A
+
+/// info |
+No Plugins available
+///
+
+----
+## B
+
+/// info |
+No Plugins available
+///
+
+----
+## C
+
+/// info |
+No Plugins available
+///
+
+----
+## D
+
+/// info |
+No Plugins available
+///
+
+----
+## E
+- **[EliteEssentials](https://www.curseforge.com/hytale/mods/eliteessentials)**
+    - [x] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md#eliteessentials)**]
+
+----
+## F
+
+/// info |
+No Plugins available
+///
+
+----
+## G
+
+/// info |
+No Plugins available
+///
+
+----
+## H
+- **[HyFactions](https://www.curseforge.com/hytale/mods/hyfactions)**
+    - [ ] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md/#hyfactions)**]
+- **[HyVotifier](https://www.curseforge.com/hytale/mods/hytale-votifier)**
+    - [ ] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md/#hyvotifier)**]
+
+----
+## I
+
+/// info |
+No Plugins available
+///
+
+----
+## J
+
+/// info |
+No Plugins available
+///
+
+----
+## K
+
+/// info |
+No Plugins available
+///
+
+----
+## L
+- **[LuckPerms](https://www.curseforge.com/hytale/mods/luckperms)**
+    - [ ] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md#luckperms)**]
+
+----
+## M
+
+/// info |
+No Plugins available
+///
+
+----
+## N
+
+/// info |
+No Plugins available
+///
+
+----
+## O
+
+/// info |
+No Plugins available
+///
+
+----
+## P
+
+/// info |
+No Plugins available
+///
+
+----
+## Q
+
+/// info |
+No Plugins available
+///
+
+----
+
+## R
+- **[RPGLevelling](https://www.curseforge.com/hytale/mods/rpg-leveling-and-stats)**
+    - [ ] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md#rpglevelling)**]
+
+----
+## S
+
+/// info |
+No Plugins available
+///
+
+----
+## T
+
+/// info |
+No Plugins available
+///
+
+----
+## U
+
+/// info |
+No Plugins available
+///
+
+----
+## V
+
+/// info |
+No Plugins available
+///
+
+----
+## W
+- **[WiFlowAPI](https://www.curseforge.com/hytale/mods/wiflows-placeholderapi)**
+    - [ ] Supports placeholders.
+    - [x] Provides own placeholders. [**[Link](../placeholder-list/hytale.md#wiflowapi)**]
+
+----
+## X
+
+/// info |
+No Plugins available
+///
+
+----
+## Y
+
+/// info |
+No Plugins available
+///
+
+----
+## Z
+
+/// info |
+No Plugins available
+///

docs/users/plugins-using-placeholderapi/index.md

@@ -0,0 +1,19 @@
+# Plugins Using PlaceholderAPI
+
+This page contains two sections listing plugins that support PlaceholderAPI, either having their own placeholders added, or by just allowing other placeholders to be used. Browse the sections below to find plugins and their available placeholders for each platform.
+
+<div class="grid cards" markdown>
+
+-   ## [Minecraft](minecraft.md)
+    
+    ----
+
+    Plugins using the Minecraft version of PlaceholderAPI.
+
+-   ## [Hytale](hytale.md)
+    
+    ----
+
+    Plugins Using the Hytale version of PlaceholderAPI.
+
+</div>

docs/users/using-placeholders.md

@@ -17,7 +17,7 @@ Before you can use placeholders should you check a few things first.
 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](plugins-using-placeholderapi.md) page.  
+One way to check, if a Plugin is supporing PlaceholderAPI, is to check the [Plugins using PlaceholderAPI](plugins-using-placeholderapi/index.md) 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.

mkdocs.yml

@@ -82,7 +82,10 @@ nav:
       - users/placeholder-list/index.md
       - users/placeholder-list/minecraft.md
       - users/placeholder-list/hytale.md
-    - users/plugins-using-placeholderapi.md
+    - Plugins Using PlaceholderAPI:
+      - users/plugins-using-placeholderapi/index.md
+      - users/plugins-using-placeholderapi/minecraft.md
+      - users/plugins-using-placeholderapi/hytale.md
   - Dev Guides:
     - developers/index.md
     - developers/using-placeholderapi.md