npm.io
2.2.1 • Published 4 months agoCLI

mc-benchmark

Licence
Apache-2.0
Version
2.2.1
Deps
6
Size
60 kB
Vulns
0
Weekly
0
Stars
23

MC Benchmark

CI Status 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

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

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

Author

Keywords