Generate .md file with all mods listed

This tool was created for the mod list of E2E-E modpack as well as for its changelogs.

This tool can be used for two purposes:

1. Generate modlist with any additional information of mods, such as mod name, description, link, image, download count and many more.
2. Generate changes by comparing two minecraftinstance.json files. Useful for changelogs or forked modpacks.

Example of resulted file with icons and formatting:

Result of comparsion two manifests:

Usage

You can use this package either as CLI tool or as library.

To use as CLI tool:

1. Install latest NodeJS for Windows or Unix

2. Open console, navigate to your Minecraft directory (one with the mods/ directory or options.txt file)

   > cd C:/Instances/MyModpack

3. Run:

   > npx @mctools/modlist --help

Options

Generate .md file with all mods listed (@mctools/modlist)

USAGE @mctools/modlist [OPTIONS] 

OPTIONS

                                  -k, --key    CurseForge API key or path to file containing it. Get one at https://console.curseforge.com/?#/api-keys. If omitted, CF_API_KEY env var is used.
                               -i, --ignore    Path to .gitignore-like file to exclude dev-only mods.                                                                                          
  -m, --mcinstance="minecraftinstance.json"    Path to minecraftinstance.json (generated by CurseForge launcher).                                                                              
                                  -l, --old    Path to old instance json to compare with (for changelog generation).                                                                           
                             --no-changelog    Fetch changelogs for updated mods from CurseForge API. Use --no-changelog to disable.                                                           
                             -t, --template    Path to Handlebar template.                                                                                                                     
                       -s, --sort="addonID"    Sort field of CurseForge addon (e.g. cf2Addon.downloadCount). Prefix with / to reverse order.                                                   
                     -o, --output="MODS.md"    Path to output file.                                                                                                                            
                              -v, --verbose    Log working process in stdout.

API

To use as library:

1. Install package

npm i @mctools/modlist

2. Import functions from package.

import fnc from '@mctools/modlist'

functions

generateModsList

generateModsList(opts): Promise<string>

Generate modlist for given minecraftinstance.json file

• opts ModListOpts — Options for mod list generator

Returns: Promise<string> — Markdown file based on given Handlebars template

Author

• https://github.com/Krutoy242

Other tools

• @mctools/errors - Scan debug.log file to find unknown errors
• @mctools/manifest - manifest.json generation tool
• @mctools/format - Format .zs files by using ESLint for typescript
• @mctools/modlist - Generate .md file with all mods listed
• @mctools/reducer - Partially disable minecraft mods
• @mctools/source - Locate, clone or decompile Minecraft mod source code
• @mctools/tcon - Tweaks Tinker Constructs' materials with csv tables
• @mctools/zsfind - Look up ZenScript class definitions, fields and method signatures from CraftTweaker dumps