MC Benchmark
> Build charts about load time of 1.12 Minecraft modpacks.
**Modded Minecraft** packs can take ~10 minutes to load. It is useful to know which mod or load step is the bottleneck.
This tool parses the `debug.log` file generated by Forge and uses the [QuickChart API](https://quickchart.io/) to generate detailed Markdown reports with charts.
## Usage
1. Install **Node.js** (v18+)
2. Open console, navigate to your Minecraft directory (the one containing the `logs/` folder).
3. Run:
```sh
npx mc-benchmark > benchmark.md
```
4. A file named `benchmark.md` will be created with all the charts and tables.
> **Note**: Minecraft must be launched at least once to generate `logs/debug.log`.
> Some launchers (like CurseForge) might disable debug logging by default. Make sure to enable it in your launcher settings. Example for [CurseForge Luncher](https://i.imgur.com/u3WD1G4.png).
### Options
```
Build charts about load time of Minecraft modpack. (mc-benchmark)
USAGE mc-benchmark [OPTIONS] [INPUT]
ARGUMENTS
INPUT debug.log path (Default: logs/debug.log)
OPTIONS
-c, --ctlog= crafttweaker.log path (Default: crafttweaker.log)
-a, --data= Output of gathered .json data
-d, --detailed= Count of detailed mods in main pie chart (Default: 16)
-t, --template= Non-default template path
-m, --modpack= Modpack name in header
-v, --verbose Verbose level -v INFO or -vv DEBUG
--cwd= Minecraft directory to OPEN files from (Default: ./)
-n, --nospaces Replace all space characters "\s" in image code. Useful for posting on GitHub. (Default: false)
```
## Examples
- **[benchmark.md](examples/benchmark.md)**: Default output.
- **[benchmark-nospaces.md](examples/benchmark-nospaces.md)**: Output with `--nospaces`, optimized for direct viewing on GitHub/GitLab.
## Author
- [Krutoy242](https://github.com/Krutoy242)