Configuration

Customizing Changelog Appearance

You have the flexibility to tailor the appearance of the generated changelog using a JSON configuration file. Follow these steps to create and customize the configuration:

How to Create a Config File

1. Run the following command to generate a new configuration file in the script directory:

   Modpack-changelogger -c new

   This will create a new configuration file that you can modify according to your preferences.

2. Open the generated config file in a text editor to customize the options.

Config Options

The default configuration looks like this:

{
    "check": {
        "added_mods": true,
        "removed_mods": true,
        "updated_mods": true,
        "loader": true,
        "mc_version": false,
        "config": false,
        "identified_overrides_mods": true,
        "unidentified_overrides_mods": false
    },
    "format": {
        "style": "bullet",
        "header": {
            "show_header": true,
            "size": 2,
            "title": "Auto",
            "show_old_version_number": false,
            "show_new_version_number": true
        }
    }
}

check

This section defines what changes should be checked when comparing the pack.

• added_mods: A boolean value. If true, the program will check for added mods. The default is true.
• removed_mods: A boolean value. If true, the program will check for removed mods. The default is true.
• updated_mods: A boolean value. If true, the program will check for updated mods. The default is true.
• loader: A boolean value. If true, the program will check for changes in the mod loader. The default is true.
• mc_version: A boolean value. If true, the program will check for changes in the Minecraft version. The default is false.
• config: A boolean value. If true, the program will check for changes in the included config folders. The default is false.
• identified_overrides_mods: A boolean value. If true, the program will try to identify the jar included as overrides and add them to the changelog if it succeeds, they will have their project name on Modrinth. The default is true.
• unidentified_overrides_mods: A boolean value. If true, the program will try to identify the jar included as overrides and add them to the changelog even if it fails, they will have their filename (like modname.jar). The default is false.

format

This section defines the format of the output.

• style: A string value. Defines the style of the output. The default is 'bullet'.
• header: A dictionary that defines the format of the header.
  • header: A boolean value. If true, a header will be included in the output. The default is true.
  • size: An integer value. Defines the size of the header. The default is 2.
  • name: A string value. Defines the name of the modpack. If set to 'Auto', the name will be automatically detected. The default is 'Auto'.
  • show_new_version_number: A boolean value. If true, the old version of the modpack will be included in the header. The default is false.
  • show_new_version_number: A boolean value. If true, the new version of the modpack will be included in the header. The default is true.

Applying Config Options

After customizing the configuration file, run the following command to generate the changelog using your specified options:

MrpackChangelogger -c path/to/config [other args]