Package Exports

mc-benchmark
mc-benchmark/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mc-benchmark) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

MC Benchmark

Latest Version

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 to generate detailed Markdown reports with charts.

Pie Chart Example

Timeline Example

Usage

Install Node.js (v18+)
Open console, navigate to your Minecraft directory (the one containing the logs/ folder).
Run:
```
npx mc-benchmark > benchmark.md
```
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.

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=<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)

Examples

benchmark.md: Default output.
benchmark-nospaces.md: Output with --nospaces, optimized for direct viewing on GitHub/GitLab.

Author

Krutoy242