https://github.com/TheBossMagnus/modpack-changelogger
A powerful and customizable Python tool to generate a changelog between two Minecraft modpacks in modrinth.mrpack or curseforge.zip format.
https://github.com/TheBossMagnus/modpack-changelogger
change-detection changelog minecraft-modpack modpack modrinth modrinth-modpack mrpack
Last synced: 8 months ago
JSON representation
A powerful and customizable Python tool to generate a changelog between two Minecraft modpacks in modrinth.mrpack or curseforge.zip format.
- Host: GitHub
- URL: https://github.com/TheBossMagnus/modpack-changelogger
- Owner: TheBossMagnus
- License: gpl-2.0
- Created: 2023-09-18T16:28:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T13:45:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T06:46:00.814Z (almost 2 years ago)
- Topics: change-detection, changelog, minecraft-modpack, modpack, modrinth, modrinth-modpack, mrpack
- Language: Python
- Homepage:
- Size: 261 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - TheBossMagnus/ModpackChangelogger - A powerful and customizable Python tool to generate a changelog between two Minecraft modpacks in modrinth.mrpack or curseforge.zip format. (Miscellaneous / In-game)
README
# Modpack Changelogger
**Modpack Changelogger** is a Python tool for comparing two Minecraft modpacks (in `.mrpack` or `.zip` format) and generating a customizable, human-readable changelog in Markdown.
[](https://deepwiki.com/TheBossMagnus/modpack-changelogger)
## Features
- **Accurate Modpack Comparison:**
Instantly see which mods, resource packs, or files were added, removed, or changed between two modpacks.
- **Minecraft & Modloader Awareness:**
Detects changes in Minecraft version, modloaders, configs file and scirpts.
- **Customizable Markdown Output:**
Generates a detailed changelog in Markdown, with multiple [output styles](https://github.com/TheBossMagnus/modpack-changelogger/wiki/Configuration#format-section).
- **Configurable:**
Supports [custom configuration files](https://github.com/TheBossMagnus/modpack-changelogger/wiki/Configuration) for advanced control over output and comparison.
- **No Python Required for Windows Users:**
Download the pre-built `.exe`—no Python installation needed!
- **Use it as a Module:**
Easily integrate into your own Python scripts or applications.
---
## Installation
**With pip (recommended):**
```bash
pip install modpack-changelogger
```
**Or download the Windows executable:**
It does not require having python installed and it's fully portable!
Grab the latest `.exe` from the [releases page](https://github.com/TheBossMagnus/modpack-changelogger/releases/latest).
> [!NOTE]
> Be aware of petential Windows Defender false positives
[See the wiki for more installation options & details.](https://github.com/TheBossMagnus/modpack-changelogger/wiki/Install-and-run)
---
## Basic Usage
| Option | Description |
|----------------|--------------------------------------------------|
| `-o`, `--old` | Path to the original/old modpack file |
| `-n`, `--new` | Path to the updated/new modpack file |
| `-c`, `--config` | (Optional) Path to a configuration file |
| `-f`, `--file` | Output file for the changelog (`console` for stdout) |
**Example:**
Compare `old_pack` to `new_pack` using `config.json`, and write the changelog to `output.md`:
```bash
modpack-changelogger -o old_pack.mrpack -n new_pack.mrpack -f output.md
```
**Print changelog to the console:**
```bash
modpack-changelogger -o old_pack.mrpack -n new_pack.mrpack -f console
```
[See the wiki for all command-line options and advanced usage.](https://github.com/TheBossMagnus/modpack-changelogger/wiki/Commands)
## Configuration
You can customize the output format and behavior using a configuration file.
To generate a default configuration file, run:
```bash
modpack-changelogger newconfig #generates a default config file
modpack-changelogger -o old_pack.mrpack -n new_pack.mrpack -c config.json # use said config file
```
[See the wiki for more details on configuration options.](https://github.com/TheBossMagnus/modpack-changelogger/wiki/Configuration)
## Run as a Module
You can also use Modpack Changelogger as a Python module in your own scripts:
```python
from modpack_changelogger import generate_changelog
generate_changelog("old_pack.mrpack","new_pack.mrpack","config.json","output.md")
```