PlaceholderAPI

PlaceholderAPI

Source: https://www.spigotmc.org/resources/placeholderapi.6245/
Source Code:
https://github.com/PlaceholderAPI/PlaceholderAPI
Contributors:
Andre_601, funnycube, Glare, NathanG, LemmoTresto, PiggyPiglet, vk2gpz, and many more

[โ€‹IMG]

[โ€‹IMG][โ€‹IMG][โ€‹IMG]โ€‹

[โ€‹IMG]โ€‹

PlaceholderAPI is a plugin/library that allows servers the use of placeholders from a wide range of your favorite plugins collectively. Essentials, Factions, LuckPerms, Vault, AutoSell, GriefPrevention, etc…. You can display information from your favorite plugins in any plugin that supports PlaceholderAPI. See a full list of placeholders and supported plugins below. Through the use of the Expansion cloud, PAPI effectively and efficiently allows you to pick and choose which placeholders you want to install. The Expansion cloud allows you to receive new placeholders, updates to existing placeholder expansions, and much more directly from your server without updating the actual plugin. With over 100,000 downloads, PlaceholderAPI is a must have for a server of any type or scale.

Placeholders2.png

Click the link below to view placeholders
Placeholders

PluginsUsing2.png

Click the link below to view plugins that hook into PlaceholderAPI
Plugins

configs2.png

config ymlโ€‹

The config yml contains the core plugin customization settings as well as a section specifically for expansions that wish to add configurable options too.

Any settings an expansion may allow you to change will be added to the config yml when that specific expansion is loaded.

Code (YAML):
# PlaceholderAPI version 2.8.1
# Created by extended_clip

check_updates
: true
cloud_enabled
: true
auto_install_expansions
: true
boolean
:
‘true’
: yes
‘false’
: no
date_format
: MM/dd/yy HH:mm:ss
expansions
:
pinger
:
offline
: offline
check_interval
: 10
online
: online
vault
:
formatting
:
thousands
: k
trillions
: T
quadrillions
: Q
billions
: B
millions
: M
bungee
:
check_interval
: 30
javascript
:
engine
: javascript
javascript_placeholders ymlโ€‹

If you have the javascript expansion enabled, the plugin will generate a javascript_placeholders yml file where you can create your own placeholders.
There are 2 ways you can create these javascript based placeholders. Either specify the javascript directly in the expression: section for each placeholder, or specify a file that the javascript will be loaded from by setting the expression to the following format –
expression: ‘file: <filename with extension>’
When an expression starts with the “file: ” keyword, a file will be created in the /plugins/PlaceholderAPI/javascripts folder with the name and file format specified if it does not exist.
These placeholders are reloaded on /placeholderapi reload so no need to restart your server to make changes.โ€‹
Code (YAML):
# javascript_placeholders yml
# You can create custom placeholders which utilize javascript to determine the result of the custom placeholder you create.
# You can specify if the result is based on a boolean or the actual javascript.
#
# If you do not specify a type: the placeholder will default to a boolean type
# A boolean type must contain a true_result: and false_result:
#
# A string type only requires the expression: entry
#
# Javascript placeholders can contain normal placeholders in the expression, true_result, or false_result
# These placeholders will be parsed to the correct values before the expression is evaluated.
#
# Your javascript placeholders will be identified by: %javascript_<identifier>%
#
# Javascript placeholder format:
#
# ย  ย  BOOLEAN TYPE
# <identifier>:
# ย  expression: <expression>
# ย  type: ‘boolean’
# ย  true_result: <result if expression is true>
# ย  false_result: <result if expression is false>
#
# ย  ย  STRING TYPE
# <identifier>:
# ย  expression: <expression>
# ย  type: ‘string’
#
#
# ย ==== ADVANCED VARIABLES ====
# DO NOT USE THESE VARIABLES UNLESS YOU KNOW WHAT YOU ARE DOING!
#
# You can access a few Bukkit API classes and methods using certain keywords:
#
# Using “BukkitServer” in your javascript will return Bukkit.getServer()
# You can use any methods inside of the Server class:
#
# Example: BukkitServer.getBannedPlayers().size().toFixed()
# Will return how many players are banned
#
# This variable is handy if you want to iterate through all online players.’
#
# Using “BukkitPlayer” in your javascript will return the Player object you are setting placeholders for.
# You can use any methods inside of the Player class:
#
# Example: BukkitPlayer.hasPermission(“some.permission”)
# Will return if the player has a specific permission
# This variable is handy if you want to check a players permission node, or access other methods inside of
# the player class for the specified player.
#
# More advanced variables are coming soon! Only use these variables if you know what you are doing!
#
# ย ==================
#
#
# Javascript placeholder examples:
#
# millionaire:
# ย  expression: ‘%vaulteco_balance% >= 1000000’
# ย  type: ‘boolean’
# ย  true_result: ‘&aMillionaire’
# ย  false_result: ‘&cbroke’
# is_staff:
# ย  expression: ‘”%vault_group%” == “Moderator” || “%vault_group%” == “Admin” || “%vault_group%” == “Owner”‘
# ย  type: ‘boolean’
# ย  true_result: ‘&bStaff’
# ย  false_result: ‘&ePlayer’
# health_rounded:
# ย  expression: ‘Math.round(%player_health%)’
# ย  type: ‘string’
# staff_online:
# ย  expression: ‘var i = 0; for (var p in BukkitServer.getOnlinePlayers()) { if (BukkitServer.getOnlinePlayers()[p].hasPermission(“staff.online”)) {i = i+1;};} i.toFixed();’
# ย  type: ‘string’
#
#
# You can optionally specify a file that the javascript expression will be loaded from if your expression
# is bigger than 1 line. To specify javascript be loaded from a file, follow this format:
#
# is_op:
# ย  expression: ‘file: is_op.js’
# ย  type: ‘string’
#
# The following placeholder will attempt to load javascript from the /plugins/PlaceholderAPI/javascripts/is_op.js file
# if the folder/file exists. If the folder/file does not exist it will be created.
# You must specify the file extension with the file name. Any file extension is accepted.

millionaire
:
expression
: %vaulteco_balance% >= 1000000′
type
: boolean
true_result
: ‘&aMillionaire’
false_result
: ‘&cbroke’
is_staff
:
expression
: ‘”%vault_group%” == “Moderator” || “%vault_group%” == “Admin” || “%vault_group%”
== “Owner”
type
: boolean
true_result
: ‘&bStaff’
false_result
: ‘&ePlayer’
staff_online
:
type
: string

 

Permissions2.png
โ€‹
Code (YAML):
permissions:
placeholderapi.admin
:
description
: ability to use admin commands
default
: op

 

Commands2.png

[โ€‹IMG]

API_Usage2.png

click the link below to view how to use this API
API USAGE

If you enjoy this completely free and powerful resource,
please be kind enough to leave a like and review!
๐Ÿ™‚

This plugin utilizes bStats to collect anonymous statistics
https://bstats.org/plugin/bukkit/PlaceholderAPIโ€‹

Leave a Reply

Your email address will not be published. Required fields are marked *

3 × 3 =

Skip to toolbar