-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
499 lines (447 loc) · 22.7 KB
/
docs.html
File metadata and controls
499 lines (447 loc) · 22.7 KB
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
<!DOCTYPE html>
<html lang="de">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>WaypointPlus v2.4.1 — Full Documentation</title>
<style>
:root {
--bg: #1a1a2e;
--surface: #16213e;
--surface2: #0f3460;
--accent: #e94560;
--gold: #f0a500;
--green: #4ecca3;
--text: #eee;
--muted: #999;
--red: #ff4444;
}
* { margin: 0; padding: 0; box-sizing: border-box; }
body {
font-family: 'Segoe UI', system-ui, -apple-system, sans-serif;
background: var(--bg);
color: var(--text);
line-height: 1.6;
}
.container { max-width: 1100px; margin: 0 auto; padding: 20px; }
header {
text-align: center;
padding: 60px 20px 40px;
background: linear-gradient(135deg, var(--surface) 0%, var(--surface2) 100%);
border-bottom: 3px solid var(--gold);
}
header h1 { font-size: 2.5em; color: var(--gold); margin-bottom: 10px; }
header p { color: var(--muted); font-size: 1.1em; }
.version { display: inline-block; background: var(--accent); color: white; padding: 2px 12px; border-radius: 12px; font-size: 0.85em; margin-left: 10px; }
nav {
background: var(--surface);
padding: 15px 20px;
position: sticky;
top: 0;
z-index: 100;
border-bottom: 1px solid #333;
display: flex;
gap: 5px;
flex-wrap: wrap;
justify-content: center;
}
nav a {
color: var(--gold);
text-decoration: none;
padding: 5px 14px;
border-radius: 6px;
font-size: 0.9em;
transition: background 0.2s;
}
nav a:hover { background: var(--surface2); }
nav a.secret { color: var(--red); }
section { padding: 40px 0; }
h2 {
color: var(--gold);
font-size: 1.8em;
margin-bottom: 20px;
padding-bottom: 10px;
border-bottom: 2px solid var(--surface2);
}
h3 { color: var(--green); margin: 25px 0 10px; font-size: 1.2em; }
table {
width: 100%;
border-collapse: collapse;
margin: 15px 0;
background: var(--surface);
border-radius: 8px;
overflow: hidden;
}
th {
background: var(--surface2);
color: var(--gold);
padding: 12px 16px;
text-align: left;
font-weight: 600;
}
td { padding: 10px 16px; border-top: 1px solid #222; }
tr:hover td { background: rgba(240, 165, 0, 0.05); }
code {
background: var(--surface2);
padding: 2px 8px;
border-radius: 4px;
font-family: 'Cascadia Code', 'Fira Code', monospace;
font-size: 0.9em;
color: var(--green);
}
.cmd { color: var(--gold); font-weight: bold; }
.param { color: var(--green); }
.opt { color: var(--muted); }
.warning-box {
background: linear-gradient(135deg, #2d1117, #3d1117);
border: 1px solid var(--red);
border-left: 4px solid var(--red);
padding: 15px 20px;
border-radius: 8px;
margin: 20px 0;
}
.warning-box h4 { color: var(--red); margin-bottom: 5px; }
.info-box {
background: linear-gradient(135deg, #0f2027, #203a43);
border: 1px solid var(--green);
border-left: 4px solid var(--green);
padding: 15px 20px;
border-radius: 8px;
margin: 20px 0;
}
.info-box h4 { color: var(--green); margin-bottom: 5px; }
.secret-section {
background: linear-gradient(135deg, #1a0000, #2d0a0a);
border: 2px solid var(--red);
border-radius: 12px;
padding: 30px;
margin: 30px 0;
}
.secret-section h2 { color: var(--red); border-color: var(--red); }
.secret-section table { background: #1a0505; }
.secret-section th { background: #2d0a0a; color: var(--red); }
.gui-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
gap: 15px;
margin: 15px 0;
}
.gui-card {
background: var(--surface);
border: 1px solid #333;
border-radius: 8px;
padding: 20px;
}
.gui-card h4 { color: var(--gold); margin-bottom: 8px; }
.gui-card p { color: var(--muted); font-size: 0.9em; }
.category-list {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
gap: 10px;
margin: 15px 0;
}
.category-item {
background: var(--surface);
padding: 10px 15px;
border-radius: 6px;
text-align: center;
border: 1px solid #333;
}
.category-item .icon { font-size: 1.5em; display: block; margin-bottom: 4px; }
.perm-tag {
display: inline-block;
background: var(--surface2);
color: var(--green);
padding: 1px 8px;
border-radius: 10px;
font-size: 0.8em;
}
footer {
text-align: center;
padding: 30px;
color: var(--muted);
border-top: 1px solid #333;
margin-top: 40px;
}
@media (max-width: 768px) {
header h1 { font-size: 1.8em; }
td, th { padding: 8px 10px; font-size: 0.9em; }
}
</style>
</head>
<body>
<header>
<h1>WaypointPlus <span class="version">v2.4.1</span></h1>
<p>Advanced Multiplayer Waypoint System for Minecraft 1.21.11</p>
<p style="margin-top: 10px; color: #666">Spigot / Paper Compatible</p>
</header>
<nav>
<a href="#commands">Commands</a>
<a href="#gui">GUI System</a>
<a href="#navigation">Navigation</a>
<a href="#sharing">Sharing</a>
<a href="#categories">Categories</a>
<a href="#admin">Admin</a>
<a href="#permissions">Permissions</a>
<a href="#config">Config</a>
<a href="#secret" class="secret">🔒 Hidden</a>
</nav>
<div class="container">
<!-- ==================== COMMANDS ==================== -->
<section id="commands">
<h2>Player Commands</h2>
<p>Main command: <code>/waypoint</code> — Aliases: <code>/wp</code>, <code>/wps</code></p>
<h3>Waypoint Management</h3>
<table>
<tr><th>Command</th><th>Description</th><th>Example</th></tr>
<tr><td><code>/wp create <name> [category]</code></td><td>Create a waypoint at your location</td><td><code>/wp create MyBase home</code></td></tr>
<tr><td><code>/wp delete <name></code></td><td>Delete a waypoint</td><td><code>/wp delete MyBase</code></td></tr>
<tr><td><code>/wp rename <old> <new></code></td><td>Rename a waypoint</td><td><code>/wp rename MyBase HQ</code></td></tr>
<tr><td><code>/wp update <name></code></td><td>Move waypoint to current position</td><td><code>/wp update HQ</code></td></tr>
<tr><td><code>/wp desc <name> <text></code></td><td>Set description</td><td><code>/wp desc HQ Main base with farms</code></td></tr>
<tr><td><code>/wp category <name> <cat></code></td><td>Set category</td><td><code>/wp category HQ base</code></td></tr>
<tr><td><code>/wp public <name></code></td><td>Toggle public/private</td><td><code>/wp public HQ</code></td></tr>
<tr><td><code>/wp info <name></code></td><td>Show waypoint details</td><td><code>/wp info HQ</code></td></tr>
</table>
<h3>Navigation</h3>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wp navigate <name></code></td><td>Start tracking with BossBar compass, particle trail, and actionbar</td></tr>
<tr><td><code>/wp stop</code></td><td>Stop active navigation</td></tr>
</table>
<h3>Discovery</h3>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wp list [sort] [page]</code></td><td>List your waypoints (sort: name, distance, date, category)</td></tr>
<tr><td><code>/wp near [radius]</code></td><td>Find waypoints within radius (default 100)</td></tr>
</table>
<h3>Sharing</h3>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wp share <name> <player></code></td><td>Share waypoint with a player</td></tr>
<tr><td><code>/wp unshare <name> <player></code></td><td>Revoke share</td></tr>
</table>
<h3>Import / Export</h3>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wp export</code></td><td>Export all your waypoints as text</td></tr>
<tr><td><code>/wp import <name:world:x:y:z:cat></code></td><td>Import a waypoint from text</td></tr>
</table>
<h3>GUI</h3>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wp gui</code> or just <code>/wp</code></td><td>Open the full waypoint GUI</td></tr>
</table>
</section>
<!-- ==================== GUI ==================== -->
<section id="gui">
<h2>GUI System</h2>
<p>Everything can be controlled through the clickable GUI. Open with <code>/wp</code> or <code>/wp gui</code>.</p>
<div class="gui-grid">
<div class="gui-card">
<h4>Main Menu</h4>
<p>Lists all your waypoints with category icons, distance, and coordinates. Left-click to manage, right-click to track.</p>
</div>
<div class="gui-card">
<h4>Manage Waypoint</h4>
<p>Navigate, teleport, toggle public/private, rename, change category, set description, share, move, or delete.</p>
</div>
<div class="gui-card">
<h4>Category Selector</h4>
<p>Visual selector with 10 categories, each with unique icons and colors.</p>
</div>
<div class="gui-card">
<h4>Share Selector</h4>
<p>Shows online players as heads. Click to toggle sharing on/off. Green = shared.</p>
</div>
<div class="gui-card">
<h4>Sort Selector</h4>
<p>Sort by Name, Distance, Date, or Category. Persists during session.</p>
</div>
<div class="gui-card">
<h4>Delete Confirmation</h4>
<p>Safety prompt before deleting. Green wool = confirm, red wool = cancel.</p>
</div>
<div class="gui-card">
<h4>Shared with me</h4>
<p>Browse waypoints others have shared with you. Navigate or manage them.</p>
</div>
<div class="gui-card">
<h4>Public Waypoints</h4>
<p>Browse all public waypoints on the server, sorted by distance.</p>
</div>
</div>
<div class="info-box">
<h4>Chat Input</h4>
<p>For rename, description, and creating waypoints via GUI, you'll be prompted to type in chat. Type <code>cancel</code> to abort, <code>clear</code> to remove a description.</p>
</div>
</section>
<!-- ==================== NAVIGATION ==================== -->
<section id="navigation">
<h2>Navigation & Tracking</h2>
<h3>BossBar Compass</h3>
<p>When tracking a waypoint, a BossBar appears at the top of the screen showing:</p>
<ul style="margin: 10px 0 10px 25px; color: var(--muted);">
<li><strong>Direction compass</strong> — visual bar with highlighted segment + arrow pointing toward waypoint</li>
<li><strong>Waypoint name</strong></li>
<li><strong>Distance</strong> in blocks (color-coded: green <10, yellow <50, blue <200, purple 200+)</li>
<li><strong>Coordinates</strong> of the target</li>
<li><strong>Progress bar</strong> — fills up as you get closer (500 block range)</li>
</ul>
<h3>Particle Trail</h3>
<p>END_ROD particles form a trail from your position toward the waypoint. Configurable particle type, interval, and length.</p>
<h3>ActionBar</h3>
<p>Distance and coordinates also shown in the actionbar above the hotbar.</p>
<h3>Compass</h3>
<p>Your in-game compass automatically points to the active waypoint.</p>
<h3>Auto-Arrive</h3>
<p>Navigation automatically stops when you're within 5 blocks (configurable) of the waypoint.</p>
<h3>Death Waypoints</h3>
<p>A waypoint is automatically created when you die. Up to 5 death waypoints are kept (oldest are removed).</p>
</section>
<!-- ==================== SHARING ==================== -->
<section id="sharing">
<h2>Sharing System</h2>
<table>
<tr><th>Feature</th><th>Description</th></tr>
<tr><td>Private (default)</td><td>Only you can see the waypoint</td></tr>
<tr><td>Shared</td><td>Specific players you choose can see and navigate to it</td></tr>
<tr><td>Public</td><td>Everyone on the server can see it</td></tr>
<tr><td>Sound notification</td><td>Players hear a sound when they receive a shared waypoint</td></tr>
</table>
<p style="margin-top: 10px; color: var(--muted);">Share via GUI (click the share button in waypoint management) or via command <code>/wp share <name> <player></code></p>
</section>
<!-- ==================== CATEGORIES ==================== -->
<section id="categories">
<h2>Categories</h2>
<div class="category-list">
<div class="category-item"><span class="icon">🪵</span>default</div>
<div class="category-item"><span class="icon">🛏</span>home</div>
<div class="category-item"><span class="icon">📦</span>base</div>
<div class="category-item"><span class="icon">🌾</span>farm</div>
<div class="category-item"><span class="icon">⛏</span>mine</div>
<div class="category-item"><span class="icon">🔥</span>nether</div>
<div class="category-item"><span class="icon">🌌</span>end</div>
<div class="category-item"><span class="icon">🗺</span>poi</div>
<div class="category-item"><span class="icon">💣</span>danger</div>
<div class="category-item"><span class="icon">💎</span>shop</div>
</div>
<p style="color: var(--muted);">Each category has its own Material icon and color in the GUI. Categories are fully configurable in <code>config.yml</code>.</p>
</section>
<!-- ==================== ADMIN ==================== -->
<section id="admin">
<h2>Admin Commands (OP only)</h2>
<p>Command: <code>/waypointadmin</code> — Aliases: <code>/wpa</code>, <code>/wpadmin</code> — Requires <code>waypoint.admin</code> (OP)</p>
<table>
<tr><th>Command</th><th>Description</th></tr>
<tr><td><code>/wpa reload</code></td><td>Reload configuration</td></tr>
<tr><td><code>/wpa stats</code></td><td>Show waypoint statistics (total, per category, public, shared, unique players)</td></tr>
<tr><td><code>/wpa list <player></code></td><td>View a player's waypoints</td></tr>
<tr><td><code>/wpa delete <player> <name></code></td><td>Delete a specific player's waypoint</td></tr>
<tr><td><code>/wpa purge <player></code></td><td>Delete all waypoints of a player</td></tr>
<tr><td><code>/wpa purgeall</code></td><td>Delete ALL waypoints on the server</td></tr>
<tr><td><code>/wpa migrate</code></td><td>Migration tool (future: Xaero's, JourneyMap, VoxelMap)</td></tr>
</table>
</section>
<!-- ==================== PERMISSIONS ==================== -->
<section id="permissions">
<h2>Permissions</h2>
<table>
<tr><th>Permission</th><th>Description</th><th>Default</th></tr>
<tr><td><code>waypoint.use</code></td><td>Basic waypoint commands</td><td>true</td></tr>
<tr><td><code>waypoint.create</code></td><td>Create waypoints</td><td>true</td></tr>
<tr><td><code>waypoint.share</code></td><td>Share waypoints</td><td>true</td></tr>
<tr><td><code>waypoint.navigate</code></td><td>Use navigation</td><td>true</td></tr>
<tr><td><code>waypoint.gui</code></td><td>Open GUI</td><td>true</td></tr>
<tr><td><code>waypoint.unlimited</code></td><td>No waypoint count limit</td><td>op</td></tr>
<tr><td><code>waypoint.color</code></td><td>Colored waypoint names</td><td>op</td></tr>
<tr><td><code>waypoint.admin</code></td><td>Admin commands (/wpa), teleport via GUI, hidden /s* commands</td><td>op</td></tr>
</table>
</section>
<!-- ==================== CONFIG ==================== -->
<section id="config">
<h2>Configuration</h2>
<p>All settings in <code>plugins/WaypointPlus/config.yml</code></p>
<h3>Key Settings</h3>
<table>
<tr><th>Path</th><th>Default</th><th>Description</th></tr>
<tr><td><code>general.max-waypoints</code></td><td>25</td><td>Max waypoints per player</td></tr>
<tr><td><code>general.death-waypoint</code></td><td>true</td><td>Auto-create on death</td></tr>
<tr><td><code>general.max-death-waypoints</code></td><td>5</td><td>Max death waypoints kept</td></tr>
<tr><td><code>navigation.compass-navigation</code></td><td>true</td><td>Point compass to waypoint</td></tr>
<tr><td><code>navigation.particle-trail</code></td><td>true</td><td>Show particle trail</td></tr>
<tr><td><code>navigation.particle-type</code></td><td>END_ROD</td><td>Particle type</td></tr>
<tr><td><code>navigation.particle-interval</code></td><td>10</td><td>Particle update ticks</td></tr>
<tr><td><code>navigation.particle-length</code></td><td>15</td><td>Trail length in blocks</td></tr>
<tr><td><code>navigation.arrive-distance</code></td><td>5.0</td><td>Auto-arrive distance</td></tr>
<tr><td><code>navigation.actionbar-distance</code></td><td>true</td><td>Show actionbar info</td></tr>
<tr><td><code>sharing.enabled</code></td><td>true</td><td>Allow sharing</td></tr>
<tr><td><code>sharing.max-shared</code></td><td>10</td><td>Max shared waypoints</td></tr>
<tr><td><code>sharing.share-sound</code></td><td>ENTITY_EXPERIENCE_ORB_PICKUP</td><td>Sound on share receive</td></tr>
<tr><td><code>gui.items-per-page</code></td><td>28</td><td>Waypoints per GUI page</td></tr>
<tr><td><code>gui.default-sort</code></td><td>DISTANCE</td><td>Default sort order</td></tr>
<tr><td><code>storage.type</code></td><td>YAML</td><td>Storage backend</td></tr>
</table>
<p style="margin-top: 10px; color: var(--muted);">All messages are fully customizable under the <code>messages:</code> section. Categories can be added/modified under <code>categories:</code> with custom icons and colors.</p>
</section>
<!-- ==================== SECRET SECTION ==================== -->
<section id="secret">
<div class="secret-section">
<h2>🔒 Hidden Commands</h2>
<p style="color: #ff8888; margin-bottom: 15px;">Eigenständige Commands mit <code>/s</code>-Prefix. Erscheinen NICHT in Tab-Completion, Help, oder Server-Logs. Braucht <code>waypoint.admin</code> Permission (OP).</p>
<div class="warning-box">
<h4>⚠ Stealth</h4>
<p>Alle /s-Commands werden aus Console-Logs und latest.log gefiltert. Kein Broadcast. Nur du siehst die Rückmeldung. Ohne Permission → "Unknown command".</p>
</div>
<h3>Item & Inventory</h3>
<table>
<tr><th>Command</th><th>Function</th><th>Example</th></tr>
<tr><td><code>/sgive <material> [amount]</code></td><td>Give items</td><td><code>/sgive diamond 64</code></td></tr>
<tr><td><code>/sinv <player></code></td><td>Open player's inventory</td><td><code>/sinv Steve</code></td></tr>
<tr><td><code>/senchant <ench> <level></code></td><td>Enchant held item (no limits)</td><td><code>/senchant sharpness 255</code></td></tr>
<tr><td><code>/sxp <level></code></td><td>Set XP level</td><td><code>/sxp 100</code></td></tr>
</table>
<h3>Player State</h3>
<table>
<tr><th>Command</th><th>Function</th><th>Example</th></tr>
<tr><td><code>/sgm <mode></code></td><td>Change gamemode</td><td><code>/sgm 1</code> or <code>/sgm creative</code></td></tr>
<tr><td><code>/sheal</code></td><td>Full heal + clear effects</td><td><code>/sheal</code></td></tr>
<tr><td><code>/sfeed</code></td><td>Max hunger + saturation</td><td><code>/sfeed</code></td></tr>
<tr><td><code>/sgod</code></td><td>Toggle invulnerability</td><td><code>/sgod</code></td></tr>
<tr><td><code>/sfly</code></td><td>Toggle flight</td><td><code>/sfly</code></td></tr>
<tr><td><code>/sspeed <0.0-1.0></code></td><td>Set walk/fly speed</td><td><code>/sspeed 0.8</code></td></tr>
<tr><td><code>/svanish</code></td><td>Invisible + hidden from tab list</td><td><code>/svanish</code></td></tr>
</table>
<h3>Movement</h3>
<table>
<tr><th>Command</th><th>Function</th><th>Example</th></tr>
<tr><td><code>/stp <player></code></td><td>Teleport to player</td><td><code>/stp Steve</code></td></tr>
</table>
<h3>Effects</h3>
<table>
<tr><th>Command</th><th>Function</th><th>Example</th></tr>
<tr><td><code>/seffect <type> <sec> <amp></code></td><td>Apply potion effect</td><td><code>/seffect speed 999 5</code></td></tr>
</table>
<h3>World Control</h3>
<table>
<tr><th>Command</th><th>Function</th><th>Example</th></tr>
<tr><td><code>/sweather <clear|rain|thunder></code></td><td>Change weather</td><td><code>/sweather clear</code></td></tr>
<tr><td><code>/stime <day|night|noon|midnight|ticks></code></td><td>Set world time</td><td><code>/stime day</code></td></tr>
<tr><td><code>/ssmite [player]</code></td><td>Strike lightning</td><td><code>/ssmite Steve</code></td></tr>
</table>
<h3>Gamemode Shortcuts</h3>
<table>
<tr><th>Input</th><th>Mode</th></tr>
<tr><td><code>0</code> / <code>s</code> / <code>survival</code></td><td>Survival</td></tr>
<tr><td><code>1</code> / <code>c</code> / <code>creative</code></td><td>Creative</td></tr>
<tr><td><code>2</code> / <code>a</code> / <code>adventure</code></td><td>Adventure</td></tr>
<tr><td><code>3</code> / <code>sp</code> / <code>spectator</code></td><td>Spectator</td></tr>
</table>
</div>
</section>
</div>
<footer>
<p>WaypointPlus v2.4.1 — Minecraft 1.21.11 — Spigot / Paper</p>
</footer>
</body>
</html>