Configuration

Configuration Structure

The configuration system is based on a json config.

Check Options

The check section determines which types of changes are analyzed and written in the generated changelog:

Mod Changes

• added_mods: Include mods that were added (default: true)
• removed_mods: Include mods that were removed (default: true)
• updated_mods: Include mods that were updated (default: true)

System Changes

• loader: Include mod loader changes like Forge or Fabric updates (default: true)
• mc_version: Include Minecraft version changes (default: false)
• config: Include configuration (/config dir) file changes (default: false)
• script: Include CraftTweak script changes (default: false)

Override Handling

Note

Overrides are mode mauly added as jar. Via their hash it's possible to determinate the project if said jar has been uploaded to Modrinth.

• identified_overrides_mods: Include override mods that can be identified (default: true)
• unidentified_overrides_mods: Include override mods that cannot be identified. The raw jar name will be used (default: false)

Format Options

The format section controls how the changelog is presented and styled.

Style Types

Four different output styles are available:

Bullet Style (Default)

Creates organized sections with bullet points for each category:

### Added:
- Mod Name 1
- Mod Name 2

### Removed:
- Mod Name 3

### Updated:
- Mod Name 4

Comma Style

Lists changes in comma-separated format:

- Added: Mod Name 1, Mod Name 2
- Removed: Mod Name 3
- Updated: Mod Name 4

Individual Bullet Style

Each change gets its own bullet point:

- Added Mod Name 1
- Added Mod Name 2
- Removed Mod Name 3
- Updated Mod Name 4

Individual Comma Style

All changes in a single paragraph with comma separation:

**Changes:** Added Mod Name 1, Added Mod Name 2, Removed Mod Name 3, Updated Mod Name 4

Header Configuration

Headers can be customized with several options:

• show_header: Whether to include a header (default: true)
• size: Header level from 1-6, corresponding to markdown # symbols (default: 2)
• title: Header text - use "auto" for automatic modpack name or specify custom text (default: "auto")
• show_old_version_number: Include the old version in header (default: false)
• show_new_version_number: Include the new version in header (default: true)