1.0.8 • Published 4 months ago

mc-benchmark v1.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

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

OptionTypeDescriptionDefault
-i, --inputstringDebug.log path"logs/debug.log"
-c, --ctlogstringcrafttweaker.log path"crafttweaker.log"
-o, --outputstringOutput file path"benchmark.md"
-n, --nospacesbooleanReplace all space characters "\s" in image codefalse
-d, --detailednumberCount of detailed mods in main pie chart20
-p, --pluginsnumberPlugin count to show in 'JEI plugins' section15
-m, --modpackstringModpack name in header
--cwdstringMinecraft directory to OPEN files from"./"
-u, --unlistedbooleanOutput unlisted tooks in consolefalse

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 npm.io, 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

1.0.8

4 months ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago