This repository has been archived by the owner on Jul 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathplaceholder_api.html
335 lines (327 loc) · 15.3 KB
/
placeholder_api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link rel="icon" type="image/png" href="assets/logo.png">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tailwindcss/2.0.2/tailwind.min.css"
integrity="sha512-+WF6UMXHki/uCy0vATJzyA9EmAcohIQuwpNz0qEO+5UeE5ibPejMRdFuARSrl1trs3skqie0rY/gNiolfaef5w=="
crossorigin="anonymous"/>
<link rel="stylesheet" href="assets/style.css"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta property="og:title" content="OpenAudioMc">
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/full.css" rel="stylesheet" type="text/css" />
<script src="https://cdn.tailwindcss.com"></script>
<meta property="og:image"
content="assets/logo.png">
<meta property="og:url" content="https://openaudiomc.net/">
<meta property="og:site_name" content="OpenAudioMc">
<meta property="og:description" content="OpenAudioMc is the all in one minecraft audio and voicechat solution">
<meta name="twitter:title" content="OpenAudioMc - The most advanced Minecraft audio and voice system">
<meta name="twitter:image"
content="assets/logo.png">
<meta name="twitter:url" content="https://twitter.com/Mindgamesnl">
<meta name="twitter:card" content="summary">
<script src="https://kit.fontawesome.com/356f5e0146.js" crossorigin="anonymous"></script>
<meta name="description"
content="A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and build scripts. - OpenAudioMc: A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and build scripts.">
<link rel="fluid-icon" href="assets/logo.png" title="OpenAudioMc">
<meta name="twitter:image:src" content="assets/banner.png"/>
<meta name="twitter:site" content="@openaudiomc"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:title"
content="OpenAudioMc: A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and build scripts."/>
<meta name="twitter:description"
content="A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and ..."/>
<meta property="og:image" content="assets/banner.png"/>
<meta property="og:image:alt"
content="A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and ..."/>
<meta property="og:site_name" content="OpenAudioMc"/>
<meta property="og:type" content="object"/>
<meta property="og:title"
content="OpenAudioMc: A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and build scripts."/>
<meta property="og:url" content="https://openaudiomc.net/"/>
<meta property="og:description"
content="A real time web client for minecraft to play and manage sounds, game notifications and much more. This project includes the plugin (bungee + spigot + velocity), common java library, web client and ..."/>
<title>OpenAudioMc - Audio for Minecraft</title>
<!-- redirect to https://minecraftvoicechat.com -->
<meta http-equiv="refresh" content="0; URL=https://minecraftvoicechat.com">
<script>
if (window.location.href.indexOf("https://minecraftvoicechat.com") == -1) {
window.location.href = "https://minecraftvoicechat.com";
}
</script>
</head>
<body class="bg-white">
<div class="px-4 py-6 mx-auto lg:py-8 sm:max-w-xl md:max-w-full lg:max-w-screen-xl md:px-24 lg:px-8">
<div class="relative flex items-center justify-between lg:justify-center lg:space-x-16">
<ul class="flex items-center flex space-x-8 lg:flex">
<li><a href="https://discord.openaudiomc.net/" aria-label="Our product" title="Our product" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">Discord</a></li>
<li><a href="https://www.spigotmc.org/resources/openaudiomc-proximity-voice-chat-realtime-music-no-mods.30691/" aria-label="Our product" title="Our product" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">Spigot</a></li>
<li><a href="https://github.com/Mindgamesnl/OpenAudioMc" aria-label="Product pricing" title="Product pricing" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">Github</a></li>
</ul>
<a href="/" aria-label="Company" title="Company" class="inline-flex items-center">
<img src="assets/logo.png" style="height: 50px">
<span class="ml-2 text-xl font-bold tracking-wide text-gray-800 uppercase">OpenAudioMc</span>
</a>
<ul class="flex items-center flex space-x-8 lg:flex">
<li><a href="https://patreon.com/mindgamesnl" aria-label="About us" title="About us" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">Patreon</a></li>
<li><a href="documentation.html" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">Documentation</a></li>
<li><a href="https://account.craftmend.com/register" aria-label="Sign up" title="Sign up" class="font-medium tracking-wide text-gray-700 transition-colors duration-200 hover:text-deep-purple-accent-400">My Account</a></li>
</ul>
<!-- Mobile menu -->
</div>
</div>
<div class="inset-x-0 bottom-0 pb-2 sm:pb-5">
<div class="mx-auto max-w-7xl px-2 sm:px-6 lg:px-8">
<div class="rounded-lg bg-red-600 p-2 shadow-lg sm:p-3">
<div class="flex flex-wrap items-center justify-between">
<div class="flex w-0 flex-1 items-center">
<span class="flex rounded-lg bg-red-800 p-2">
<svg class="h-6 w-6 text-white" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true">
<path stroke-linecap="round" stroke-linejoin="round" d="M10.34 15.84c-.688-.06-1.386-.09-2.09-.09H7.5a4.5 4.5 0 110-9h.75c.704 0 1.402-.03 2.09-.09m0 9.18c.253.962.584 1.892.985 2.783.247.55.06 1.21-.463 1.511l-.657.38c-.551.318-1.26.117-1.527-.461a20.845 20.845 0 01-1.44-4.282m3.102.069a18.03 18.03 0 01-.59-4.59c0-1.586.205-3.124.59-4.59m0 9.18a23.848 23.848 0 018.835 2.535M10.34 6.66a23.847 23.847 0 008.835-2.535m0 0A23.74 23.74 0 0018.795 3m.38 1.125a23.91 23.91 0 011.014 5.395m-1.014 8.855c-.118.38-.245.754-.38 1.125m.38-1.125a23.91 23.91 0 001.014-5.395m0-3.46c.495.413.811 1.035.811 1.73 0 .695-.316 1.317-.811 1.73m0-3.46a24.347 24.347 0 010 3.46" />
</svg>
</span>
<p class="ml-3 font-medium text-white">
<span class="md:hidden"><b>This article is outdated! please update to the latest OpenAudioMc version and visit the docs on <a class="text-indigo-100" href="https://openaudiomc.net/docs">our new website</a></b></span>
<span class="hidden md:inline"><b>This article is outdated! please update to the latest OpenAudioMc version and visit the docs on <a class="text-indigo-100" href="https://openaudiomc.net/docs">our new website</a></b></span>
</p>
</div>
<div class="order-3 mt-2 w-full flex-shrink-0 sm:order-2 sm:mt-0 sm:w-auto">
<a href="https://discord.openaudiomc.net/" class="flex items-center justify-center rounded-md border border-transparent bg-white px-4 py-2 text-sm font-medium text-indigo-600 shadow-sm hover:bg-indigo-50">Support Discord</a>
</div>
</div>
</div>
</div>
</div>
<section class="text-gray-700 bg-gray-200 body-font">
<div class="container mx-auto">
<div class="flex flex-col">
<div class="h-1 bg-gray-800 rounded overflow-hidden">
<div class="w-24 h-full bg-purple-400"></div>
</div>
<div class="flex flex-wrap sm:flex-row flex-col py-6 mb-12">
<h1 class="sm:w-2/5 title-font text-2xl mb-2 sm:mb-0">PlaceholderAPI Integration</h1>
<p class="sm:w-3/5 leading-relaxed sm:pl-10 pl-0">Hooking into PAPI with OpenAudioMc</p>
</div>
</div>
</div>
</section>
<section class="text-gray-700 bg-gray-200 body-font">
<div class="container px-5 mx-auto flex flex-col">
<div class="lg:w-4/6 mx-auto">
<div class="sm:py-8 mt-4 pt-4 sm:mt-0">
<div class="inset-x-0 bottom-0 pb-2 sm:pb-5">
<div class="mx-auto max-w-7xl px-2 sm:px-6 lg:px-8">
<div class="rounded-lg bg-red-600 p-2 shadow-lg sm:p-3">
<div class="flex flex-wrap items-center justify-between">
<div class="flex w-0 flex-1 items-center">
<span class="flex rounded-lg bg-red-800 p-2">
<svg class="h-6 w-6 text-white" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true">
<path stroke-linecap="round" stroke-linejoin="round" d="M10.34 15.84c-.688-.06-1.386-.09-2.09-.09H7.5a4.5 4.5 0 110-9h.75c.704 0 1.402-.03 2.09-.09m0 9.18c.253.962.584 1.892.985 2.783.247.55.06 1.21-.463 1.511l-.657.38c-.551.318-1.26.117-1.527-.461a20.845 20.845 0 01-1.44-4.282m3.102.069a18.03 18.03 0 01-.59-4.59c0-1.586.205-3.124.59-4.59m0 9.18a23.848 23.848 0 018.835 2.535M10.34 6.66a23.847 23.847 0 008.835-2.535m0 0A23.74 23.74 0 0018.795 3m.38 1.125a23.91 23.91 0 011.014 5.395m-1.014 8.855c-.118.38-.245.754-.38 1.125m.38-1.125a23.91 23.91 0 001.014-5.395m0-3.46c.495.413.811 1.035.811 1.73 0 .695-.316 1.317-.811 1.73m0-3.46a24.347 24.347 0 010 3.46" />
</svg>
</span>
<p class="ml-3 font-medium text-white">
<span class="md:hidden"><b>This article is outdated! please update to the latest OpenAudioMc version and visit the docs on <a class="text-indigo-100" href="https://openaudiomc.net/docs">our new website</a></b></span>
<span class="hidden md:inline"><b>This article is outdated! please update to the latest OpenAudioMc version and visit the docs on <a class="text-indigo-100" href="https://openaudiomc.net/docs">our new website</a></b></span>
</p>
</div>
<div class="order-3 mt-2 w-full flex-shrink-0 sm:order-2 sm:mt-0 sm:w-auto">
<a href="https://discord.openaudiomc.net/" class="flex items-center justify-center rounded-md border border-transparent bg-white px-4 py-2 text-sm font-medium text-indigo-600 shadow-sm hover:bg-indigo-50">Support Discord</a>
</div>
</div>
</div>
</div>
</div>
<h1 id="papi-integration">
PAPI Integration
</h1>
<p>
<div style="padding: 20px;
background-color: #f44336;
color: white;">
<strong>
WARNING!
</strong>
Our PlaceholderAPI provider is only registered for the spigot instance </div>
<br>
OpenAudioMc supports the
<a href="https://www.spigotmc.org/resources/placeholderapi.6245/" rel="nofollow">
PlaceholderAPI
</a>
plugin. This means that you can display data from OpenAudioMc in your chat, scoreboard, tablist and more.
</p>
<p>
Be careful not to expose your token to the public, as it can be used to impersonate you.
<br>
<br/>
</p>
<h2 id="placeholders">
Placeholders
</h2>
<p>
All our placeholders use the
<code>
oa_
</code>
prefix, and return values can be configured in our
<code>
config.yml
</code>
file.
</p>
<table>
<thead>
<tr>
<th>
Placeholder
</th>
<th>
Description
</th>
<th>
Example
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
oa_connect_client
</code>
</td>
<td>
Connection state of the client in context
</td>
<td>
<code>
Connected!
</code>
</td>
</tr>
<tr>
<td>
<code>
oa_connect_vc
</code>
</td>
<td>
Connection state to voicechat in context
</td>
<td>
<code>
Not conneced to voice chat!
</code>
</td>
</tr>
<tr>
<td>
<code>
oa_count_client
</code>
</td>
<td>
The amount of players with the client open
</td>
<td>
<code>
5
</code>
</td>
</tr>
<tr>
<td>
<code>
oa_count_vc
</code>
</td>
<td>
The amount of players in voice chat
</td>
<td>
<code>
3
</code>
</td>
</tr>
<tr>
<td>
<code>
oa_count_vc_max
</code>
</td>
<td>
The maximum amount of voicechat slots. Useful to displays like
<sup>
5
</sup>
⁄
<sub>
10
</sub>
</td>
<td>
<code>
8
</code>
</td>
</tr>
<tr>
<td>
<code>
oa_token
</code>
</td>
<td>
Shows the personal token of a player, should never be public in tab.
</td>
<td>
<code>
38dDy
</code>
</td>
</tr>
</tbody>
</table>
<p>
<br/>
</p>
<h2 id="testing">
Testing
</h2>
<p>
You can easily validate if your placeholders are working by using the
<code>
/papi parse
</code>
command. For example, to test the
<code>
oa_token
</code>
placeholder, you would run
<code>
/papi parse <player> %oa_token%
</code>
.
</p>
</div>
</div>
</div>
</section>
<footer class="text-gray-400 bg-gray-900 body-font">
<div class="container px-5 py-8 mx-auto flex items-center sm:flex-row flex-col">
<a href="index.html"
class="flex title-font font-medium items-center md:justify-start justify-center text-white">
<img src="assets/logo.png" alt="logo openaudiomc" class="w-10 h-10 text-white bg-indigo-500 rounded-full logo"/>
<span class="ml-3 text-xl">OpenAudioMc</span>
</a>
<p class="text-sm text-gray-400 sm:ml-4 sm:pl-4 sm:border-l-2 sm:border-gray-800 sm:py-2 sm:mt-0 mt-4">© 2022
OpenAudioMc —
<a href="https://twitter.com/Mindgamesnl" class="text-gray-500 ml-1" target="_blank"
rel="noopener noreferrer">@Mindgamesnl</a>
</p>
</div>
</footer>
</body>
</html>