JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 61
  • Score
    100M100P100Q73868F
  • License MIT

Build charts about load time of Minecraft modpack.

Package Exports

  • mc-benchmark
  • mc-benchmark/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

License: MIT

Build charts about load time of 1.12 Minecraft modpack.

Modded Minecraft modpack could takes ~10 minutes to load. Its could be useful to know, what mod or load step takes so long.
This script parsing debug.log file, generated by Forge, and using https://quickchart.io/ API to generate chart images.

Usage

  1. Install latest NodeJS for Windows or Unix

  2. Open console, navigate to your Minecraft directory (one with the logs/ directory or crafttweaker.log file)

    > cd C:/Instances/MyModpack

  3. Run:

    > npx mc-benchmark

  4. File benchmark.md would be generated in current working directory.

Minecraft must be launched at least once in advance to generate file logs/debug.log.

Some lunchers disable the creation of a logs/debug.log file. Change the settings of your luncher in such a case. Example for CurseForge Luncher.

crafttweaker.log file is not necessary.

Options

Option Type Description Default
-i, --input string Debug.log path "logs/debug.log"
-c, --ctlog string crafttweaker.log path "crafttweaker.log"
-o, --output string Output file path "benchmark.md"
-n, --nospaces boolean Replace all space characters "\s" in image code false
-d, --detailed number Count of detailed mods in main pie chart 20
-p, --plugins number Plugin count to show in 'JEI plugins' section 15
-m, --modpack string Modpack name in header
--cwd string Minecraft directory to OPEN files from "./"
-u, --unlisted boolean Output unlisted tooks in console false

Examples

  • examples/benchmark.md - Default output without options.
    Useful for version control, because all data that would be changed on new mc-benchmark run would be changed in separate lines. On Github you will see missed images , because GitHub cant parse spaces.
  • examples/benchmark--nospaces.md - Replace all space characters \s+ with %20. Messed up formatting, but could be seen from GitHub

Author