# mc-benchmark

> Build charts about load time of Minecraft modpack.

Latest version **2.2.1** (published 2026-04-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install mc-benchmark
pnpm add mc-benchmark
yarn add mc-benchmark
bun add mc-benchmark
```

Provides the command `mc-benchmark`.

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2026-04-28 |
| First published | 2021-12-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 59.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Krutoy242 |
| Maintainers | krutoy242 |
| Keywords | minecraft, chart, quickchart, benchmark, mods, debug, modpack |

## Links

- npm: https://www.npmjs.com/package/mc-benchmark
- Repository: https://github.com/Krutoy242/mc-benchmark
- Homepage: https://github.com/Krutoy242/mc-benchmark#readme
- Issues: https://github.com/Krutoy242/mc-benchmark/issues
- npm.io page: https://npm.io/package/mc-benchmark

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^5.6.2
- [citty](https://npm.io/package/citty.md) ^0.2.2
- [color](https://npm.io/package/color.md) ^5.0.3
- [consola](https://npm.io/package/consola.md) ^3.4.2
- [color-hash](https://npm.io/package/color-hash.md) ^2.0.2
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.9

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 2.2.1 (latest) — 2026-04-28
- 2.2.0 — 2026-04-28
- 2.1.0 — 2025-05-16
- 2.0.3 — 2025-05-12
- 2.0.2 — 2025-05-12
- 2.0.1 — 2025-05-08
- 2.0.0 — 2025-05-08
- 1.0.9 — 2024-06-02
- 1.0.8 — 2023-12-30
- 1.0.7 — 2023-04-27
- 1.0.6 — 2023-04-27
- 1.0.5 — 2022-08-04
- 1.0.4 — 2022-01-11
- 1.0.3 — 2021-12-30
- 1.0.2 — 2021-12-28
- … 4 more at https://npm.io/package/mc-benchmark/versions

## README

<h1 align="center">MC Benchmark</h1>

<p align="center">
  <img src="https://github.com/Krutoy242/mc-benchmark/actions/workflows/ci.yml/badge.svg" alt="CI Status" />
  <img src="https://img.shields.io/github/v/release/Krutoy242/mc-benchmark" alt="Latest Version" />
</p>

> 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.

<p align="center"><img src="https://i.imgur.com/uZj6wS1.png" alt="Pie Chart Example"/></p>
<p align="center"><img src="https://i.imgur.com/PolHIWi.png" alt="Timeline Example"/></p>

## 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

<!-- OPTIONS_START -->
```
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=<ctlog>    crafttweaker.log path (Default: crafttweaker.log)                                              
          -a, --data=<data>    Output of gathered .json data                                                                  
  -d, --detailed=<detailed>    Count of detailed mods in main pie chart (Default: 16)                                         
  -t, --template=<template>    Non-default template path                                                                      
    -m, --modpack=<modpack>    Modpack name in header                                                                         
              -v, --verbose    Verbose level -v INFO or -vv DEBUG                                                             
                --cwd=<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)
```
<!-- OPTIONS_END -->

## 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)

---
_Source: https://npm.io/package/mc-benchmark · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
