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
|
# toml++ `tomlplusplus/`
> **Type**: TOML Parser Library
> **License**: MIT
> **Fork Origin**: [GitHub](https://github.com/marzer/tomlplusplus)
> **Status**: Detached Fork (independently maintained)
> **Specification**: [TOML v1.0.0](https://toml.io/en/v1.0.0)
> **Latest Version**: 0.0.5-1
[](https://github.com/Project-Tick/ProjT-Launcher/actions/workflows/ci-new.yml)
---
## Overview
toml++ is a header-only TOML configuration file parser and serializer for C++17 and later. It provides a clean, intuitive API for reading and writing TOML files with full TOML v1.0.0 compliance.
ProjT Launcher maintains a detached fork for independent development and CI integration.
---
## Usage in ProjT Launcher
toml++ is used for:
- **Configuration files** — Reading launcher settings
- **Instance configs** — Parsing instance metadata
- **Mod manifests** — Processing `fabric.mod.json` alternatives
- **Pack metadata** — Reading modpack configuration
---
## Features
| Feature | Status |
|---------|--------|
| TOML v1.0.0 compliant | ✅ |
| Header-only library | ✅ |
| C++17/20/23 support | ✅ |
| Unicode support | ✅ |
| Serialize to TOML | ✅ |
| Parse from string/file | ✅ |
| Error messages with line numbers | ✅ |
| Compile-time optimizations | ✅ |
---
## Quick Start
### Single Header Include
```cpp
#include <toml++/toml.hpp>
```
### Parse TOML
```cpp
// From string
auto config = toml::parse(R"(
[server]
host = "localhost"
port = 8080
)");
// From file
auto config = toml::parse_file("config.toml");
// Access values
std::string host = config["server"]["host"].value_or("127.0.0.1");
int port = config["server"]["port"].value_or(80);
```
### Create TOML
{% raw %}
```cpp
auto tbl = toml::table{{
{"server", toml::table{{
{"host", "localhost"},
{"port", 8080}
}}}
}};
std::cout << tbl << std::endl;
```
{% endraw %}
---
## Build Integration
### CMake (Recommended)
toml++ is header-only, but provides a CMake target:
```cmake
# Add as subdirectory
add_subdirectory(tomlplusplus)
# Or find installed package
find_package(tomlplusplus REQUIRED)
# Link to your target
target_link_libraries(your_target PRIVATE tomlplusplus::tomlplusplus)
```
### Include Directly
```cmake
target_include_directories(your_target PRIVATE path/to/tomlplusplus/include)
```
### Compiler Requirements
| Compiler | Minimum Version |
|----------|-----------------|
| GCC | 8+ |
| Clang | 8+ |
| MSVC | 19.20+ (VS 2019) |
| ICC | 19.11+ |
---
## Configuration Options
Define before including to customize behavior:
```cpp
// Disable exceptions
#define TOML_EXCEPTIONS 0
// Disable optional features
#define TOML_ENABLE_FORMATTERS 0
#define TOML_ENABLE_PARSER 0 // Write-only mode
// Unicode handling
#define TOML_ASSUME_UTF8_EVERYWHERE 1
```
---
## Error Handling
### With Exceptions (Default)
```cpp
try {
auto config = toml::parse_file("config.toml");
} catch (const toml::parse_error& err) {
std::cerr << "Parse error at " << err.source().begin << ":\n"
<< err.description() << std::endl;
}
```
### Without Exceptions
```cpp
#define TOML_EXCEPTIONS 0
toml::parse_result result = toml::parse_file("config.toml");
if (!result) {
std::cerr << "Parse error: " << result.error() << std::endl;
return;
}
toml::table& config = result.table();
```
---
## Testing
toml++ includes a comprehensive test suite:
```bash
cd tomlplusplus
mkdir build && cd build
cmake .. -DTOML_BUILD_TESTS=ON
cmake --build .
ctest -V
```
See [ci-tomlplusplus.yml](../../.github/workflows/ci-tomlplusplus.yml) for CI configuration.
---
## Documentation
| Resource | Description |
|----------|-------------|
| [API Docs](https://projecttick.org/tomlplusplus/) | Full API reference |
| [TOML Spec](https://toml.io/en/v1.0.0) | TOML v1.0.0 specification |
| [Original README](../../tomlplusplus/README.md) | Upstream library documentation |
| [Website Build](./website-tomlplusplus.md) | Building API docs |
---
## Copyright & Licensing
```
Copyright (c) Mark Gillard <mark.gillard@outlook.com.au>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software to deal in the Software without restriction, including the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
```
Full license: `tomlplusplus/LICENSE`
---
## Related Documentation
- [cmark](./cmark.md) — Markdown parser (similar use case)
- [libnbt++](./libnbtplusplus.md) — NBT format parser
- [Website toml++ Docs](./website-tomlplusplus.md) — Building documentation
- [Third-party Libraries](./third-party.md) — All dependencies
---
## External Links
- [toml++ GitHub](https://github.com/marzer/tomlplusplus)
- [TOML Official Site](https://toml.io/)
- [toml++ Online Docs](https://marzer.github.io/tomlplusplus/)
- [TOML Test Suite](https://github.com/BurntSushi/toml-test)
|
