-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
1476 lines (1352 loc) · 80.4 KB
/
docs.html
File metadata and controls
1476 lines (1352 loc) · 80.4 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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://cdnjs.cloudflare.com https://unpkg.com https://*.googlesyndication.com https://*.doubleclick.net https://*.google.com; style-src 'self' 'unsafe-inline' https://cdnjs.cloudflare.com https://fonts.googleapis.com; font-src 'self' data: https://fonts.gstatic.com https://cdnjs.cloudflare.com; img-src 'self' data: blob: https:; connect-src 'self' https://api.leafclient.com https://cdn.leafclient.com https://api.github.com https://flagcdn.com https://starlightskins.lunareclipse.studio https://*.googlesyndication.com https://*.doubleclick.net https://a-ads.com; frame-src 'self' https://*.lemonsqueezy.com https://*.googlesyndication.com https://*.doubleclick.net https://stats.uptimerobot.com https://a-ads.com; form-action 'self' https://*.lemonsqueezy.com; object-src 'none'; base-uri 'self'; upgrade-insecure-requests">
<meta name="referrer" content="strict-origin-when-cross-origin">
<meta http-equiv="Permissions-Policy" content="geolocation=(), microphone=(), camera=(), payment=(self "https://*.lemonsqueezy.com")">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Leaf Client Documentation — Installation Guide, Mods Reference & Setup</title>
<meta name="description" content="Complete Leaf Client documentation. Installation guide, first-time setup, all 35+ mods explained, HUD editor tutorial, cosmetics guide, server compatibility, and troubleshooting.">
<link rel="canonical" href="https://leafclient.com/docs.html">
<link rel="icon" href="assets/logo.png">
<link rel="stylesheet" href="style.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css" media="print" onload="this.media='all'" integrity="sha384-/o6I2CkkWC//PSjvWC/eYN7l3xM3tJm8ZzVkCOfp//W05QcE3mlGskpoHB6XqI+B" crossorigin="anonymous" referrerpolicy="no-referrer">
<noscript><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css" integrity="sha384-/o6I2CkkWC//PSjvWC/eYN7l3xM3tJm8ZzVkCOfp//W05QcE3mlGskpoHB6XqI+B" crossorigin="anonymous" referrerpolicy="no-referrer"></noscript>
<meta name="theme-color" content="#2ecc71">
<meta property="og:type" content="website">
<meta property="og:url" content="https://leafclient.com/docs.html">
<meta property="og:title" content="Leaf Client Documentation">
<meta property="og:description" content="Complete documentation for Leaf Client. Installation, mods reference, HUD editor, cosmetics guide, and troubleshooting.">
<meta property="og:image" content="https://leafclient.com/assets/logo.png">
<style> .docs-layout {
display: flex;
max-width: var(--max);
margin: 0 auto;
padding: calc(var(--nav-h) + 3rem) var(--gut) 6rem;
gap: 3rem;
align-items: flex-start;
position: relative;
z-index: 2;
}
.docs-sidebar {
width: 220px;
flex-shrink: 0;
position: sticky;
top: calc(var(--nav-h) + 2rem);
max-height: calc(100vh - var(--nav-h) - 4rem);
overflow-y: auto;
scrollbar-width: thin;
scrollbar-color: var(--border) transparent;
}
.docs-sidebar::-webkit-scrollbar { width: 4px; }
.docs-sidebar::-webkit-scrollbar-track { background: transparent; }
.docs-sidebar::-webkit-scrollbar-thumb { background: var(--border); border-radius: 2px; }
.docs-sidebar-label {
font-size: 0.65rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.12em;
color: var(--text3);
margin-bottom: 0.75rem;
padding-left: 0.75rem;
}
.docs-nav-group {
margin-bottom: 1.75rem;
}
.docs-nav-group-title {
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--text3);
padding: 0.25rem 0.75rem;
margin-bottom: 0.25rem;
}
.docs-nav a {
display: flex;
align-items: center;
gap: 0.5rem;
font-size: 0.82rem;
color: var(--text2);
padding: 0.4rem 0.75rem;
border-radius: 6px;
transition: color 0.25s, background 0.25s;
border-left: 2px solid transparent;
}
.docs-nav a:hover {
color: var(--text);
background: rgba(255,255,255,0.04);
}
.docs-nav a.active {
color: var(--green);
background: rgba(46,204,113,0.08);
border-left-color: var(--green);
}
.docs-nav a i {
width: 14px;
font-size: 0.75rem;
opacity: 0.7;
}
.docs-content {
flex: 1;
min-width: 0;
}
.docs-section {
margin-bottom: 4rem;
scroll-margin-top: calc(var(--nav-h) + 2rem);
}
.docs-section-eyebrow {
display: inline-flex;
align-items: center;
gap: 0.4rem;
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--green);
margin-bottom: 0.6rem;
}
.docs-section h2 {
font-family: 'Sora', system-ui, sans-serif;
font-size: clamp(1.5rem, 3vw, 2rem);
font-weight: 700;
line-height: 1.2;
letter-spacing: -0.02em;
margin-bottom: 0.75rem;
}
.docs-section > p,
.docs-section .docs-lead {
font-size: 0.95rem;
color: var(--text2);
line-height: 1.75;
max-width: 680px;
margin-bottom: 1.5rem;
}
.docs-section h3 {
font-family: 'Sora', system-ui, sans-serif;
font-size: 1.05rem;
font-weight: 600;
margin: 2rem 0 0.6rem;
color: var(--text);
}
.docs-section p {
font-size: 0.875rem;
color: var(--text2);
line-height: 1.75;
margin-bottom: 0.75rem;
}
.docs-divider {
border: none;
border-top: 1px solid var(--border);
margin: 3rem 0;
}
.docs-hero {
background: linear-gradient(135deg, rgba(46,204,113,0.07) 0%, rgba(46,204,113,0.02) 100%);
border: 1px solid rgba(46,204,113,0.15);
border-radius: 16px;
padding: 2.5rem;
margin-bottom: 3rem;
position: relative;
overflow: hidden;
}
.docs-hero::before {
content: '';
position: absolute;
top: -40px; right: -40px;
width: 200px; height: 200px;
background: radial-gradient(circle, rgba(46,204,113,0.12) 0%, transparent 70%);
pointer-events: none;
}
.docs-hero-eyebrow {
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.12em;
color: var(--green);
margin-bottom: 0.5rem;
}
.docs-hero h1 {
font-family: 'Sora', system-ui, sans-serif;
font-size: clamp(1.75rem, 4vw, 2.5rem);
font-weight: 700;
letter-spacing: -0.02em;
margin-bottom: 0.75rem;
}
.docs-hero p {
font-size: 0.9rem;
color: var(--text2);
line-height: 1.7;
max-width: 560px;
margin-bottom: 0;
}
.callout {
border-radius: 10px;
padding: 1rem 1.25rem;
margin: 1.25rem 0;
font-size: 0.85rem;
line-height: 1.65;
display: flex;
gap: 0.75rem;
align-items: flex-start;
}
.callout i { flex-shrink: 0; margin-top: 2px; font-size: 0.9rem; }
.callout-info {
background: rgba(46,204,113,0.06);
border: 1px solid rgba(46,204,113,0.18);
color: var(--text2);
}
.callout-info i { color: var(--green); }
.callout-warn {
background: rgba(241,196,15,0.06);
border: 1px solid rgba(241,196,15,0.2);
color: var(--text2);
}
.callout-warn i { color: #f1c40f; }
.callout-server {
background: rgba(155,89,182,0.07);
border: 1px solid rgba(155,89,182,0.2);
color: var(--text2);
}
.callout-server i { color: #9b59b6; }
.code-block {
background: #111;
border: 1px solid var(--border);
border-radius: 10px;
overflow: hidden;
margin: 1rem 0 1.5rem;
}
.code-block-header {
display: flex;
align-items: center;
justify-content: space-between;
padding: 0.6rem 1rem;
background: rgba(255,255,255,0.03);
border-bottom: 1px solid var(--border);
}
.code-lang {
font-size: 0.7rem;
font-weight: 600;
color: var(--text3);
text-transform: uppercase;
letter-spacing: 0.08em;
}
.code-copy {
font-size: 0.72rem;
color: var(--text3);
background: none;
border: none;
cursor: pointer;
display: flex;
align-items: center;
gap: 0.35rem;
transition: color 0.2s;
padding: 0;
}
.code-copy:hover { color: var(--green); cursor: pointer; }
.code-block pre {
padding: 1.25rem;
overflow-x: auto;
margin: 0;
}
.code-block code {
font-family: 'Fira Code', 'Cascadia Code', 'Consolas', monospace;
font-size: 0.8rem;
line-height: 1.65;
color: #c9d1d9;
white-space: pre;
}
kw { color: #ff7b72; }
cm { color: #8b949e; font-style: italic; }
st { color: #a5d6ff; }
ty { color: #79c0ff; }
fn { color: #d2a8ff; }
nu { color: #f8c555; }
an { color: #ffa657; }
code {
font-family: 'Fira Code', 'Cascadia Code', 'Consolas', monospace;
font-size: 0.8rem;
background: rgba(255,255,255,0.06);
border: 1px solid var(--border);
border-radius: 4px;
padding: 0.1em 0.4em;
color: var(--green);
}
.docs-mod-grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(260px, 1fr));
gap: 1rem;
margin: 1.25rem 0;
}
.docs-mod-card {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 10px;
padding: 1rem 1.25rem;
transition: border-color 0.25s, transform 0.3s var(--spring);
}
.docs-mod-card:hover {
border-color: rgba(46,204,113,0.25);
transform: translateY(-2px);
}
.docs-mod-card-header {
display: flex;
align-items: center;
gap: 0.6rem;
margin-bottom: 0.4rem;
}
.docs-mod-card-header i {
color: var(--green);
font-size: 0.85rem;
width: 16px;
}
.docs-mod-card h4 {
font-size: 0.875rem;
font-weight: 600;
color: var(--text);
}
.docs-mod-badge {
font-size: 0.62rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.06em;
padding: 0.15em 0.5em;
border-radius: 4px;
margin-left: auto;
}
.badge-hud { background: rgba(46,204,113,0.12); color: var(--green); }
.badge-mechanic { background: rgba(52,152,219,0.12); color: #3498db; }
.badge-visual { background: rgba(155,89,182,0.12); color: #9b59b6; }
.badge-server { background: rgba(241,196,15,0.12); color: #f1c40f; }
.docs-mod-card p {
font-size: 0.78rem;
color: var(--text2);
line-height: 1.6;
margin: 0;
}
.docs-steps {
list-style: none;
counter-reset: step;
margin: 1rem 0 1.5rem;
}
.docs-steps li {
counter-increment: step;
display: flex;
gap: 1rem;
margin-bottom: 1.25rem;
align-items: flex-start;
}
.docs-steps li::before {
content: counter(step);
display: flex;
align-items: center;
justify-content: center;
min-width: 28px;
height: 28px;
border-radius: 50%;
background: rgba(46,204,113,0.12);
border: 1px solid rgba(46,204,113,0.25);
color: var(--green);
font-size: 0.75rem;
font-weight: 700;
flex-shrink: 0;
margin-top: 2px;
}
.docs-steps li > div {
flex: 1;
}
.docs-steps li strong {
display: block;
font-size: 0.875rem;
color: var(--text);
margin-bottom: 0.25rem;
}
.docs-steps li p {
margin: 0;
font-size: 0.82rem;
color: var(--text2);
line-height: 1.6;
}
.docs-feature-list {
list-style: none;
margin: 0.75rem 0 1.5rem;
}
.docs-feature-list li {
display: flex;
align-items: flex-start;
gap: 0.6rem;
padding: 0.45rem 0;
border-bottom: 1px solid var(--border);
font-size: 0.85rem;
color: var(--text2);
}
.docs-feature-list li:last-child { border-bottom: none; }
.docs-feature-list li i {
color: var(--green);
margin-top: 2px;
font-size: 0.75rem;
flex-shrink: 0;
}
.channel-pill {
display: inline-flex;
align-items: center;
gap: 0.4rem;
background: rgba(155,89,182,0.1);
border: 1px solid rgba(155,89,182,0.25);
border-radius: 6px;
padding: 0.3rem 0.65rem;
font-size: 0.8rem;
font-family: 'Fira Code', monospace;
color: #c39bd3;
margin: 0.25rem 0;
}
.docs-table {
width: 100%;
border-collapse: collapse;
font-size: 0.82rem;
margin: 1rem 0 1.5rem;
}
.docs-table th {
text-align: left;
padding: 0.6rem 1rem;
border-bottom: 1px solid var(--border);
color: var(--text3);
font-size: 0.7rem;
text-transform: uppercase;
letter-spacing: 0.08em;
font-weight: 600;
}
.docs-table td {
padding: 0.65rem 1rem;
border-bottom: 1px solid rgba(255,255,255,0.04);
color: var(--text2);
line-height: 1.5;
}
.docs-table tr:last-child td { border-bottom: none; }
.docs-table td:first-child { color: var(--text); font-family: 'Fira Code', monospace; font-size: 0.78rem; }
.docs-progress {
height: 2px;
background: linear-gradient(90deg, var(--green), rgba(46,204,113,0.1));
border-radius: 1px;
margin-bottom: 3rem;
opacity: 0.5;
}
@media (max-width: 860px) {
.docs-layout { flex-direction: column; gap: 2rem; }
.docs-sidebar { width: 100%; position: static; }
.docs-nav { display: flex; flex-wrap: wrap; gap: 0.4rem; }
.docs-nav-group { margin-bottom: 0; }
.docs-nav-group-title { display: none; }
.docs-nav a { font-size: 0.78rem; padding: 0.3rem 0.65rem; }
}
</style>
</head>
<body>
<div class="custom-cursor" id="custom-cursor"></div>
<div class="custom-cursor-outer" id="custom-cursor-outer"></div>
<canvas id="leaf-particles" class="leaf-canvas"></canvas>
<nav class="nav scrolled" id="nav">
<div class="nav-inner">
<a href="index.html" class="nav-logo">
<img src="assets/logo.png" alt="Leaf" width="30" height="30">
<span>Leaf Client</span>
</a>
<div class="nav-links" id="nav-links">
<a href="index.html#features">Features</a>
<a href="index.html#showcase">Showcase</a>
<a href="index.html#compare">Compare</a>
<a href="index.html#about">About</a>
<a href="docs.html" class="active">Docs</a>
<a href="store.html">Store</a>
<a href="blog.html">Blog</a>
<a href="status.html">Status</a>
<a href="https://github.com/LeafClientMC/LeafClient" target="_blank" rel="noopener">GitHub</a>
</div>
<div class="nav-actions">
<a href="download.html" class="nav-cta">Download</a>
<div class="nav-account" id="nav-account">
<button class="nav-login-btn hidden" id="nav-login-btn">Log In</button>
<div class="nav-player-wrap hidden" id="nav-player-wrap">
<button class="nav-player-btn" id="nav-player-btn">
<img class="nav-player-head" id="nav-player-head" src="" alt="" width="26" height="26">
<span class="nav-player-name" id="nav-player-name"></span>
<i class="fa-solid fa-chevron-down nav-chevron"></i>
</button>
<div class="nav-dropdown" id="nav-dropdown">
<button class="nav-dropdown-item danger" id="nav-logout-item">
<i class="fa-solid fa-right-from-bracket"></i> Sign Out
</button>
</div>
</div>
</div>
<button class="nav-toggle" id="nav-toggle" aria-label="Toggle menu">
<span></span><span></span>
</button>
</div>
</div>
</nav>
<div class="docs-layout">
<aside class="docs-sidebar">
<div class="docs-sidebar-label">Documentation</div>
<div class="docs-nav-group">
<div class="docs-nav-group-title">Overview</div>
<nav class="docs-nav">
<a href="#intro" class="active"><i class="fa-solid fa-house"></i> Introduction</a>
<a href="#getting-started"><i class="fa-solid fa-rocket"></i> Getting Started</a>
<a href="#system-requirements"><i class="fa-solid fa-microchip"></i> Requirements</a>
</nav>
</div>
<div class="docs-nav-group">
<div class="docs-nav-group-title">The Launcher</div>
<nav class="docs-nav">
<a href="#launcher-overview"><i class="fa-solid fa-desktop"></i> Overview</a>
<a href="#launcher-profiles"><i class="fa-solid fa-user"></i> Profiles</a>
<a href="#launcher-settings"><i class="fa-solid fa-sliders"></i> Settings</a>
</nav>
</div>
<div class="docs-nav-group">
<div class="docs-nav-group-title">Mods</div>
<nav class="docs-nav">
<a href="#mods-overview"><i class="fa-solid fa-cubes"></i> All Mods</a>
<a href="#hud-mods"><i class="fa-solid fa-gauge"></i> HUD Mods</a>
<a href="#mechanic-mods"><i class="fa-solid fa-gear"></i> Mechanics</a>
<a href="#visual-mods"><i class="fa-solid fa-eye"></i> Visual</a>
<a href="#server-mods"><i class="fa-solid fa-server"></i> Server</a>
</nav>
</div>
<div class="docs-nav-group">
<div class="docs-nav-group-title">For Servers</div>
<nav class="docs-nav">
<a href="#server-control"><i class="fa-solid fa-shield"></i> Server Control</a>
<a href="#plugin-channel"><i class="fa-solid fa-plug"></i> Plugin Channel</a>
<a href="#disable-spectate"><i class="fa-solid fa-ban"></i> Disable Spectate</a>
<a href="#disable-freelook"><i class="fa-solid fa-eye-slash"></i> Disable Freelook</a>
<a href="#disable-fullbright"><i class="fa-solid fa-sun"></i> Disable FullBright</a>
<a href="#disable-fastbuilder"><i class="fa-solid fa-ban"></i> Disable Fast Builder</a>
</nav>
</div>
</aside>
<main class="docs-content">
<div class="docs-hero">
<div class="docs-hero-eyebrow"><i class="fa-solid fa-book-open"></i> Documentation</div>
<h1>Leaf Client Docs</h1>
<p>Everything you need to know about using, configuring, and integrating Leaf Client — from installing the launcher to controlling features on your server.</p>
</div>
<section class="docs-section" id="intro">
<div class="docs-section-eyebrow"><i class="fa-solid fa-leaf"></i> Overview</div>
<h2>What is Leaf Client?</h2>
<p class="docs-lead">Leaf Client is a free, open-source Minecraft client built on Fabric. It ships with 35+ built-in mods — HUD elements, QoL mechanics, and performance optimizations — all configurable in-game or through the dedicated launcher.</p>
<div class="callout callout-info">
<i class="fa-solid fa-circle-info"></i>
<div>Leaf Client is currently in <strong>beta</strong>. Features are actively being developed and improved. Join the <a href="https://discord.gg/wvYqKpUNdb" style="color:var(--green)">Discord</a> to follow updates and report issues.</div>
</div>
<ul class="docs-feature-list">
<li><i class="fa-solid fa-check"></i> 35+ built-in mods, all toggle-able and configurable</li>
<li><i class="fa-solid fa-check"></i> Dedicated Windows launcher with profile management</li>
<li><i class="fa-solid fa-check"></i> Supports Minecraft 1.20.1 through 1.21.11 (Fabric)</li>
<li><i class="fa-solid fa-check"></i> Sodium & Lithium bundled by default for maximum performance</li>
<li><i class="fa-solid fa-check"></i> Discord Rich Presence integration</li>
<li><i class="fa-solid fa-check"></i> Cosmetics system (wings, crowns, particles)</li>
<li><i class="fa-solid fa-check"></i> Server-side feature control via plugin messaging channel</li>
</ul>
</section>
<hr class="docs-divider">
<section class="docs-section" id="getting-started">
<div class="docs-section-eyebrow"><i class="fa-solid fa-rocket"></i> Setup</div>
<h2>Getting Started</h2>
<p class="docs-lead">Get up and running in under a minute. All you need is Windows, Java, and a valid Minecraft Java Edition account.</p>
<ol class="docs-steps">
<li>
<div>
<strong>Download the Launcher</strong>
<p>Head to the <a href="download.html" style="color:var(--green)">Download page</a> and grab the latest Windows installer. Run the <code>.exe</code> — no additional setup required.</p>
</div>
</li>
<li>
<div>
<strong>Sign in with Microsoft</strong>
<p>The launcher uses Microsoft OAuth for authentication. Click <strong>Sign In</strong>, complete the browser flow, and your account will be saved for future launches.</p>
</div>
</li>
<li>
<div>
<strong>Select a Minecraft version</strong>
<p>Pick your version from the version selector. Leaf Client supports <strong>1.20.1 through 1.21.11 (Fabric)</strong>. Fabric, Sodium, and Lithium are installed automatically.</p>
</div>
</li>
<li>
<div>
<strong>Hit Launch</strong>
<p>Press the launch button. The launcher will download all required files on first run, then open the game. Subsequent launches are instant.</p>
</div>
</li>
<li>
<div>
<strong>Open the mod menu in-game</strong>
<p>Press <kbd style="background:var(--bg-card);border:1px solid var(--border);padding:0.1em 0.4em;border-radius:4px;font-size:0.8rem">Right Shift</kbd> to open the Leaf Client mod menu. Toggle mods on/off and configure them per your preferences.</p>
</div>
</li>
</ol>
</section>
<hr class="docs-divider">
<section class="docs-section" id="system-requirements">
<div class="docs-section-eyebrow"><i class="fa-solid fa-microchip"></i> Requirements</div>
<h2>System Requirements</h2>
<table class="docs-table">
<thead>
<tr>
<th>Requirement</th>
<th>Minimum</th>
<th>Recommended</th>
</tr>
</thead>
<tbody>
<tr><td>OS</td><td>Windows 10 (64-bit)</td><td>Windows 11</td></tr>
<tr><td>Java</td><td>Java 17</td><td>Java 21</td></tr>
<tr><td>RAM</td><td>4 GB system RAM</td><td>8 GB+</td></tr>
<tr><td>GPU</td><td>OpenGL 4.5 capable</td><td>Dedicated GPU</td></tr>
<tr><td>Minecraft</td><td>Java Edition (any)</td><td>Java Edition 1.21+</td></tr>
<tr><td>Disk</td><td>2 GB free space</td><td>4 GB+ free space</td></tr>
</tbody>
</table>
<div class="callout callout-warn">
<i class="fa-solid fa-triangle-exclamation"></i>
<div>macOS and Linux are not yet supported. They are planned for a future release.</div>
</div>
</section>
<hr class="docs-divider">
<section class="docs-section" id="launcher-overview">
<div class="docs-section-eyebrow"><i class="fa-solid fa-desktop"></i> Launcher</div>
<h2>The Launcher</h2>
<p class="docs-lead">The Leaf Client Launcher is a standalone Windows application that manages your Minecraft installations, profiles, mods, and account — all in one place.</p>
<h3>Key launcher features</h3>
<ul class="docs-feature-list">
<li><i class="fa-solid fa-check"></i> <strong>One-click launch</strong> — downloads Fabric, Sodium, Lithium, and the Leaf Client mod automatically</li>
<li><i class="fa-solid fa-check"></i> <strong>Profile system</strong> — create multiple profiles with different versions, mods, and JVM settings</li>
<li><i class="fa-solid fa-check"></i> <strong>Version selector</strong> — switch between any supported Minecraft version instantly</li>
<li><i class="fa-solid fa-check"></i> <strong>JVM configurator</strong> — set custom JVM arguments or RAM allocation per profile</li>
<li><i class="fa-solid fa-check"></i> <strong>Quick Join</strong> — auto-connect to a server address on launch</li>
<li><i class="fa-solid fa-check"></i> <strong>Discord Rich Presence</strong> — shows what you're playing in Discord</li>
<li><i class="fa-solid fa-check"></i> <strong>Auto-update</strong> — checks for launcher and mod updates on startup</li>
</ul>
</section>
<section class="docs-section" id="launcher-profiles">
<div class="docs-section-eyebrow"><i class="fa-solid fa-user"></i> Profiles</div>
<h2>Profiles</h2>
<p class="docs-lead">Profiles let you save different configurations — useful if you play on multiple servers or want separate setups for PvP and survival.</p>
<h3>Creating a profile</h3>
<p>Click the profile icon in the launcher top bar, then <strong>New Profile</strong>. Give it a name, pick a Minecraft version, and choose your mod preset. Profiles are saved locally and persist between sessions.</p>
<h3>Profile settings</h3>
<table class="docs-table">
<thead><tr><th>Setting</th><th>Description</th></tr></thead>
<tbody>
<tr><td>mc_version</td><td>Minecraft version this profile launches</td></tr>
<tr><td>mod_preset</td><td>Which bundled mods are active (Sodium + Lithium always included)</td></tr>
<tr><td>jvm_args</td><td>Custom JVM flags appended to the launch command</td></tr>
<tr><td>ram_min / ram_max</td><td>Minimum and maximum heap memory allocation</td></tr>
<tr><td>quick_join</td><td>Server address to connect to automatically on load</td></tr>
<tr><td>resolution</td><td>Game window width and height</td></tr>
</tbody>
</table>
</section>
<section class="docs-section" id="launcher-settings">
<div class="docs-section-eyebrow"><i class="fa-solid fa-sliders"></i> Settings</div>
<h2>Launcher Settings</h2>
<h3>Performance flags</h3>
<p>The launcher automatically applies Aikar's recommended JVM garbage collection flags to every launch. These improve GC pauses and reduce stuttering in-game:</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-lang">JVM Flags (applied automatically)</span>
</div>
<pre><code>-XX:+UseG1GC
-XX:+UnlockExperimentalVMOptions
-XX:G1NewSizePercent=20
-XX:G1ReservePercent=20
-XX:MaxGCPauseMillis=50
-XX:G1HeapRegionSize=32M
-XX:+DisableExplicitGC
-XX:+AlwaysPreTouch
-XX:+ParallelRefProcEnabled</code></pre>
</div>
<p>You can add your own flags on top of these via <strong>Settings → JVM Arguments</strong>. Custom flags are appended after the defaults.</p>
<h3>RAM allocation</h3>
<p>Use the RAM sliders in Settings to control minimum and maximum heap size. Recommended: <strong>2–4 GB</strong> for most setups. Allocating too much RAM can actually hurt performance due to longer GC cycles.</p>
</section>
<hr class="docs-divider">
<section class="docs-section" id="mods-overview">
<div class="docs-section-eyebrow"><i class="fa-solid fa-cubes"></i> Mods</div>
<h2>Built-in Mods</h2>
<p class="docs-lead">All mods are accessible via the in-game mod menu (<kbd style="background:var(--bg-card);border:1px solid var(--border);padding:0.1em 0.4em;border-radius:4px;font-size:0.8rem">Right Shift</kbd>). Each mod can be toggled independently. Settings are saved automatically and persist across sessions.</p>
</section>
<section class="docs-section" id="hud-mods">
<div class="docs-section-eyebrow"><i class="fa-solid fa-gauge"></i> HUD</div>
<h2>HUD Mods</h2>
<p>HUD mods display information overlays on your screen. All HUD elements can be repositioned using the <strong>HUD Editor</strong> (accessible from the mod menu).</p>
<div class="docs-mod-grid">
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-video"></i>
<h4>FPS HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Displays your current frames per second in a configurable corner of the screen. You can choose the position, text color, and whether to show a colored indicator that turns red when FPS drops below a threshold you set. Useful for monitoring performance without opening an external tool.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-arrow-pointer"></i>
<h4>CPS HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Shows clicks per second for left and right mouse buttons, tracked over a rolling one-second window. Configurable position, scale, and color — you can also choose to display one button or both. Commonly used in PvP to verify clicking technique and spot inconsistencies.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-wifi"></i>
<h4>Ping HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Displays your current server latency in milliseconds, updated every second. Position and color are configurable, and you can optionally set color thresholds so the number turns yellow or red when latency climbs above values you define. Works on any server — reads the standard ping from the tab list.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-location-crosshairs"></i>
<h4>Coordinates HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Shows your X, Y, Z coordinates and current biome name at all times. You can toggle each field independently — for example, display only X/Z for navigation while hiding Y. The direction you are facing (N/S/E/W) can also be enabled as an optional sub-label.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-shield-halved"></i>
<h4>Armor HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Displays your equipped armor pieces and their remaining durability as both a numeric value and a color-coded bar. The bar transitions from green to yellow to red as durability drops, giving you an at-a-glance warning before a piece breaks. Each slot (helmet, chestplate, leggings, boots) is shown individually and can be hidden if empty.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-keyboard"></i>
<h4>Keystrokes</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Shows real-time WASD, jump, and mouse key presses on screen. Configurable colors, scale, and animations.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-box"></i>
<h4>Item Counter</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Tracks the total count of a specific item across your entire inventory, including hotbar, main inventory, and offhand. You can pin any item type to watch — useful for tracking arrows, food, or building materials mid-session. Auto-detection mode automatically highlights the item currently in your main hand.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-microchip"></i>
<h4>Performance HUD</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Displays CPU usage and memory consumption so you can monitor system load without alt-tabbing. Shows used vs. allocated heap memory and overall JVM CPU time, updated every second. Useful for diagnosing lag spikes or confirming that your RAM allocation is appropriately sized for your setup.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-server"></i>
<h4>Server Info</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Shows the current server IP address and online player count on your HUD, pulled directly from the server connection. The player count updates in real time as people join or leave. You can configure which fields are visible and choose to display a custom label instead of the raw IP for cleaner presentation on known servers.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-map"></i>
<h4>Minimap</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Renders a real-time top-down minimap that updates as you explore, built on an optimized chunk-scanning system. Size, zoom level, and screen position are all configurable. Waypoints you create are shown as labeled pins on the map, and an optional coordinates overlay displays your current position beneath the minimap frame.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-calendar-day"></i>
<h4>Day Counter</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Displays the current in-game day number, time of day as a 24-hour clock, and the current moon phase icon. Each element can be toggled independently so you only show what you need. Handy for planning nighttime activities or tracking how many days have passed in a survival world.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-leaf"></i>
<h4>Leaf Logo</h4>
<span class="docs-mod-badge badge-hud">HUD</span>
</div>
<p>Shows the Leaf Client branding logo on your HUD. Purely cosmetic — it has no effect on gameplay. Position and scale are configurable, and you can disable it entirely if you prefer a clean screen. It is on by default as a subtle indicator that you are running Leaf Client.</p>
</div>
</div>
</section>
<section class="docs-section" id="mechanic-mods">
<div class="docs-section-eyebrow"><i class="fa-solid fa-gear"></i> Mechanics</div>
<h2>Mechanic Mods</h2>
<p>These mods change how you interact with the game — movement, camera, and visibility.</p>
<div class="docs-mod-grid">
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-eye"></i>
<h4>Spectate</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Press <code>Left Alt</code> to enter spectate mode. Your camera detaches and floats freely — look and move around without affecting your character's position. Press again to return. <strong>Servers can disable this.</strong></p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-person-running"></i>
<h4>Toggle Sprint</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Sprint and sneak by toggling instead of holding. Supports fly speed boost when sprinting in creative mode.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-magnifying-glass"></i>
<h4>Zoom</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Hold <code>C</code> to zoom in. Scroll the mouse wheel while zooming to adjust the zoom level. Smooth cinematic zoom transitions included.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-sun"></i>
<h4>FullBright</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Maximizes in-game brightness so you can see in caves and dark areas without needing torches or night vision. It works by overriding the client-side gamma value and has no effect on the server — other players see normal lighting. <strong>Servers can disable this</strong> via the <code>leafclient:control</code> channel if their gameplay depends on darkness.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-wind"></i>
<h4>Motion Blur</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Adds a configurable motion blur effect when panning the camera, implemented via a post-processing shader for smooth, high-quality results. Blur intensity is adjustable — lower values give a subtle cinematic feel while higher values produce a more dramatic effect. Has no performance impact on most modern GPUs since it runs entirely on the GPU pipeline.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-lightbulb"></i>
<h4>Dynamic Lights</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Held light-emitting items — torches, glowstone, lanterns, sea lanterns, and similar blocks — cast real-time light onto nearby blocks and entities as you move. This is purely client-side and does not affect the server's lighting engine or other players. It significantly improves visibility when mining or exploring without committing to placing torches everywhere.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-gauge-high"></i>
<h4>Performance</h4>
<span class="docs-mod-badge badge-mechanic">Mechanic</span>
</div>
<p>Enables a suite of client-side culling optimizations including entity occlusion culling, shadow distance caps, and block entity distance culling. Each optimization reduces the number of objects the renderer has to process per frame, which translates directly to higher and more stable frame rates — especially on servers with many players or complex builds nearby. Individual toggles let you enable only the optimizations that suit your hardware.</p>
</div>
</div>
</section>
<section class="docs-section" id="visual-mods">
<div class="docs-section-eyebrow"><i class="fa-solid fa-eye"></i> Visual</div>
<h2>Visual Mods</h2>
<div class="docs-mod-grid">
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-crosshairs"></i>
<h4>Custom Crosshair</h4>
<span class="docs-mod-badge badge-visual">Visual</span>
</div>
<p>Replace the default crosshair with a fully customizable one. Adjust size, gap, dot visibility, and color.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-droplet"></i>
<h4>Custom Hit Color</h4>
<span class="docs-mod-badge badge-visual">Visual</span>
</div>
<p>Changes the red hurt flash that appears on entities when they take damage to any RGB color you choose. Supports a chroma (rainbow cycling) mode with configurable cycle speed for a more distinctive look. The change is purely visual and client-side — it has no effect on other players or the server.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-cloud-sun-rain"></i>
<h4>Weather Changer</h4>
<span class="docs-mod-badge badge-visual">Visual</span>
</div>
<p>Overrides the client-side weather rendering so you always see clear skies, constant rain, or a perpetual thunderstorm — regardless of what the server's actual weather is. The override is local only and does not affect other players or server-side weather mechanics. Useful for screenshots, performance testing, or simply preferring a consistent visual environment.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-expand"></i>
<h4>Totem Size Changer</h4>
<span class="docs-mod-badge badge-visual">Visual</span>
</div>
<p>Resizes and adjusts the opacity of the totem pop overlay animation that plays when a totem of undying activates. The default overlay fills the entire screen, which some players find disorienting in high-stakes moments. You can scale it down significantly or reduce its opacity so you stay aware of your surroundings during the animation.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-palette"></i>
<h4>HUD Themes</h4>
<span class="docs-mod-badge badge-visual">Visual</span>
</div>
<p>Applies global theming to all HUD elements, letting you change accent color, background opacity, and font style across every HUD mod in a single step rather than configuring each one individually. Theme presets are planned, and custom theme values can be saved and loaded. Note: full theme switching is still in development — basic color and opacity controls are available now.</p>
</div>
</div>
</section>
<hr class="docs-divider">
<section class="docs-section" id="server-mods">
<div class="docs-section-eyebrow"><i class="fa-solid fa-server"></i> Server</div>
<h2>Server Mods</h2>
<div class="docs-mod-grid">
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-map-pin"></i>
<h4>Waypoints</h4>
<span class="docs-mod-badge badge-server">Server</span>
</div>
<p>Create named waypoints at any coordinate and have them displayed as floating labels in the world at their location. Waypoints are stored per-server so your markers on one server do not bleed into another. Open the waypoints list from the mod menu to edit, delete, or teleport your camera to any saved point. They also appear as pins on the Minimap if that mod is enabled.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-comment-dots"></i>
<h4>Chat Macros</h4>
<span class="docs-mod-badge badge-server">Server</span>
</div>
<p>Bind any chat message or command to a key so you can send it instantly without typing. Each macro stores a label, a key binding, and the message text — supports server commands like <code>/kit</code> or <code>/home</code> as well as regular chat. You can define as many macros as you need and manage them all from the mod settings panel.</p>
</div>
<div class="docs-mod-card">
<div class="docs-mod-card-header">
<i class="fa-solid fa-plug-circle-xmark"></i>
<h4>Smart Disconnect</h4>
<span class="docs-mod-badge badge-server">Server</span>
</div>
<p>Shows a confirmation dialog whenever you attempt to disconnect from a server, preventing accidental disconnects from a misclick or a stray key press. The dialog requires an explicit confirm before the connection is closed. You can whitelist specific servers where you want the prompt skipped if you disconnect from them frequently by choice.</p>
</div>
</div>
</section>
<hr class="docs-divider">
<section class="docs-section" id="server-control">
<div class="docs-section-eyebrow"><i class="fa-solid fa-shield-halved"></i> For Server Operators</div>
<h2>Server-Side Feature Control</h2>
<p class="docs-lead">Leaf Client supports a plugin messaging channel that lets servers disable specific client features at runtime. This is useful if your server wants to restrict the use of Spectate mode, Minimap, or any other mod.</p>
<div class="callout callout-server">
<i class="fa-solid fa-server"></i>
<div>This system is <strong>per-session</strong>. Features are re-enabled when the player disconnects and reconnects. Servers should send the disable payload on player join.</div>
</div>
<h3>How it works</h3>
<p>When a player joins your server, your plugin sends a plugin message on the <span class="channel-pill"><i class="fa-solid fa-plug"></i> leafclient:control</span> channel. The payload is a UTF-8 encoded JSON object listing the mod IDs you want to disable.</p>
<p>Leaf Client receives the packet and immediately disables every listed mod for the duration of the session. The player's local settings are not permanently changed — everything returns to normal on reconnect. Players cannot override or re-enable server-disabled features while they remain connected.</p>
<p>This uses the standard Minecraft plugin messaging protocol and is supported by <strong>every major server platform</strong>: Bukkit, Spigot, Paper, Purpur, Velocity, BungeeCord, Sponge, Fabric server-side, and more. Vanilla clients that do not register the channel will silently ignore the packet.</p>
<h3>Payload format</h3>
<p>Send a single JSON object with a <code>disabled</code> array containing the mod IDs to restrict. You can disable one mod or several in a single packet.</p>
<div class="code-block">