63 lines
3.2 KiB
HTML
63 lines
3.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>ET Placeholders Wiki</title>
|
|
<style>
|
|
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; line-height: 1.6; max-width: 800px; margin: 0 auto; padding: 20px; color: #333; }
|
|
h1, h2, h3 { color: #2c3e50; border-bottom: 1px solid #eee; padding-bottom: 5px; }
|
|
code { background: #f4f4f4; padding: 2px 5px; border-radius: 3px; font-family: monospace; }
|
|
pre { background: #f4f4f4; padding: 15px; border-radius: 5px; overflow-x: auto; }
|
|
.placeholder-list { list-style: none; padding: 0; }
|
|
.placeholder-list li { margin-bottom: 10px; background: #fff; padding: 10px; border: 1px solid #ddd; border-radius: 5px; }
|
|
.placeholder-list code { font-weight: bold; color: #e74c3c; }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
|
|
<h1>ET Placeholders Wiki</h1>
|
|
<p>A PlaceholderAPI expansion for fetching player tiers and leaderboards from the EaglerTiers API.</p>
|
|
|
|
<h2>Installation</h2>
|
|
<ol>
|
|
<li>Ensure you have <strong>PlaceholderAPI</strong> installed on your server.</li>
|
|
<li>Drop the <code>et_placeholders1.0.2.jar</code> into your <code>plugins</code> folder.</li>
|
|
<li>Restart your server.</li>
|
|
<li>To get an api key, open a ticket on the discord https://discord.eaglertiers.com. You need a key for this! Configure your <code>api-key</code> in <code>plugins/ETPlaceholders/config.yml</code>.</li>
|
|
<li>Run <code>/papi reload</code> or restart the server.</li>
|
|
</ol>
|
|
|
|
<h2>Configuration (config.yml)</h2>
|
|
<pre><code># ET Placeholders Configuration
|
|
|
|
# To get an api key, open a ticket on the discord https://discord.eaglertiers.com You need a key for this
|
|
api-key: ""
|
|
|
|
# How often (in minutes) to refresh cached player and leaderboard data.
|
|
# Do not set this too low or you may hit the API rate limit (120 req/min).
|
|
cache-refresh-minutes: 15
|
|
|
|
# Value to display when a tier or player is not found
|
|
not-found-text: "Unranked"</code></pre>
|
|
|
|
<h2>Available Placeholders</h2>
|
|
|
|
<h3>Player Data</h3>
|
|
<ul class="placeholder-list">
|
|
<li><code>%et_rank%</code><br>Returns the player's overall rank position on EaglerTiers.</li>
|
|
<li><code>%et_tier_<gamemode>%</code><br>Returns the player's tier for a specific gamemode. Example: <code>%et_tier_vanilla%</code></li>
|
|
</ul>
|
|
|
|
<h3>Leaderboard Data</h3>
|
|
<ul class="placeholder-list">
|
|
<li><code>%et_top_name_<gamemode>_<position>%</code><br>Returns the username of the player at the specified leaderboard position. Example: <code>%et_top_name_overall_1%</code></li>
|
|
<li><code>%et_top_tier_<gamemode>_<position>%</code><br>Returns the tier of the player at the specified leaderboard position. Example: <code>%et_top_tier_vanilla_3%</code></li>
|
|
</ul>
|
|
|
|
<h3>Supported Gamemodes</h3>
|
|
<p><code>overall</code>, <code>vanilla</code>, <code>mace</code>, <code>axe</code>, <code>sword</code>, <code>smp</code>, <code>diamondsmp</code>, <code>uhc</code>, <code>pot</code>, <code>nethop</code>, <code>cart</code></p>
|
|
|
|
</body>
|
|
</html>
|