blob: 64e4c809c47e5f61337faf0c3f3898e6711300f0 (
plain)
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
|
# Libraries
> **Purpose**: Overview of all external dependencies used by ProjT Launcher
---
## Overview
ProjT Launcher includes several third-party libraries for various functionality. This document provides a quick reference to all external dependencies.
---
## Detached Fork Libraries
These libraries are **detached forks** — independently maintained by Project Tick, not synchronized with original repositories:
### Compression
| Library | Purpose | License | Documentation |
|---------|---------|---------|---------------|
| **zlib** | DEFLATE compression | zlib | [zlib.md](./zlib.md) |
| **bzip2** | Block-sorting compression | BSD-like | [bzip2.md](./bzip2.md) |
| **QuaZip** | Qt ZIP wrapper | LGPL-2.1+ | [quazip.md](./quazip.md) |
### Data Formats
| Library | Purpose | License | Documentation |
|---------|---------|---------|---------------|
| **toml++** | TOML parser | MIT | [tomlplusplus.md](./tomlplusplus.md) |
| **libnbt++** | NBT format | GPL-3.0 | [libnbtplusplus.md](./libnbtplusplus.md) |
| **cmark** | Markdown parser | BSD-2-Clause | [cmark.md](./cmark.md) |
### Utilities
| Library | Purpose | License | Documentation |
|---------|---------|---------|---------------|
| **libqrencode** | QR code generation | LGPL-2.1+ | [libqrencode.md](./libqrencode.md) |
### Build System
| Library | Purpose | License | Documentation |
|---------|---------|---------|---------------|
| **Extra CMake Modules** | CMake utilities | BSD-3-Clause | [extra-cmake-modules.md](./extra-cmake-modules.md) |
---
## Original READMEs
Each detached fork retains its original upstream documentation. These are preserved for reference but are not actively maintained by Project Tick:
| Library | Documentation |
|---------|---------------|
| toml++ | `tomlplusplus/README.md` |
| libqrencode | `libqrencode/README.md` |
| ECM | `extra-cmake-modules/README.md` |
| zlib | `zlib/README-cmake.md`, `zlib/FAQ` |
| bzip2 | `bzip2/bzip2.txt`, `bzip2/manual.html` |
| cmark | `cmark/changelog.txt`, `cmark/man/` |
| QuaZip | `quazip/QuaZip-1.x-migration.md` |
| libnbt++ | `libnbtplusplus/include/` (headers) |
For Project Tick–specific documentation and usage, refer to the handbook pages linked above.
---
## Internal Libraries
These are ProjT Launcher-specific libraries:
### LocalPeer `LocalPeer/`
Single-instance application enforcement.
- **Origin**: Derived from QtSingleApplication
- **License**: BSD
- **Use**: Prevents multiple launcher instances
### murmur2 `murmur2/`
Hash function implementation.
- **Origin**: [SMHasher](https://github.com/aappleby/smhasher)
- **License**: Public Domain
- **Use**: Content hashing for mods
### rainbow `rainbow/`
Color manipulation functions.
- **Origin**: KGuiAddons
- **License**: LGPL-2.1+
- **Use**: Adaptive text coloring
### systeminfo `systeminfo/`
System information probing.
- **License**: Apache-2.0
- **Use**: Hardware/OS detection
### qdcss `qdcss/`
Quick and dirty CSS parser.
- **Origin**: NilLoader
- **License**: LGPL-3.0
- **Use**: Mod metadata parsing
---
## External Dependencies
These are system/Qt dependencies not bundled:
### Qt Framework
| Module | Purpose |
|--------|---------|
| Qt Core | Base functionality |
| Qt GUI | UI rendering |
| Qt Widgets | UI components |
| Qt Network | HTTP/networking |
| Qt Concurrent | Threading |
### System Libraries
| Library | Purpose | Platforms |
|---------|---------|-----------|
| OpenSSL | TLS/HTTPS | All |
| libpng | PNG images | All |
| zlib (system) | Alternative to bundled | Optional |
---
## License Summary
| License | Libraries |
|---------|-----------|
| **MIT** | toml++ |
| **BSD-2/3-Clause** | cmark, gamemode |
| **BSD-like** | bzip2, LocalPeer |
| **zlib** | zlib |
| **LGPL-2.1+** | QuaZip, rainbow, libqrencode |
| **LGPL-3.0** | qdcss |
| **GPL-3.0** | libnbt++ |
| **Apache-2.0** | systeminfo |
| **Public Domain** | murmur2 |
---
## Adding New Dependencies
When adding new libraries:
1. **Evaluate license compatibility** with GPL-3.0
2. **Create handbook documentation** in `docs/handbook/`
3. **Update this file** with the new entry
4. **Add CI workflow** if needed
5. **Update CMakeLists.txt** for build integration
---
## Related Documentation
- [Workflows](./workflows.md) — CI for libraries
- [README](./README.md) — Handbook index
|
