Metadata-Version: 2.1
Name: modpack_changelogger
Version: 1.0.0b1
Summary: A powerful and customizable Python tool to generate a changelog between two Minecraft modpacks in modrinth.mrpack or curseforge.zip format.
Home-page: https://github.com/TheBossMagnus/ModpackChangelogger
Author: TheBossMagnus
Author-email: thebossmagnus@proton.me
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.9.5

# ModpackChangelogger
ModpackChangelogger is a Python tool that compares two Minecraft Modpacks (in modrinth.mrpack or curseforge.zip format) and generates a markdown changelog to show the difference between them.


## Features
- **Precise Comparison**: Easily spot added, removed, and modified items, changes to the Minecraft version, and updates to modloaders.
- **Markdown Output**: View the differences in a markdown document with various [styles](https://github.com/TheBossMagnus/ModpackChangelogger/wiki/Configuration#format-section) options.
- **Configurability**: You can customize output through a [config file](https://github.com/TheBossMagnus/ModpackChangelogger/wiki/Configuration).
- **Multi-Platform**: Run it on Windows or Linux, no Python installation required.

## Installation
Download the source code from the latest release and run it with the python interpreter:
```bash
python ModpackChangelogger.py [args]
```
Or use the compiled windows `.exe`.
More information [on the wiki](https://github.com/TheBossMagnus/ModpackChangelogger/wiki/Install-and-run).
## Basic Usage
- `-o`, `--old`: Specify the first pack to compare.
- `-n`, `--new`: Specify the pack to compare  against.

E.g:Compare `old_pack` to `new_pack` using the settings in `config.json`, and write the output to `output.md`.
```bash
python ModpackChangelogger -o old_pack -n new_pack -c config.json -f output.md
```
More information [on the wiki](https://github.com/TheBossMagnus/ModpackChangelogger/wiki/Commands).

## Limitations
* Mod added as .jar file(overrides) aren't checked

>This is my first time using python, so if you have any suggestion about code quality or performance feel free to pr them! And, if something isn't working correctly, sorry. Please open an [issue](https://github.com/TheBossMagnus/ModpackChangelogger/issues)https://github.com/TheBossMagnus/ModpackChangelogger/issues and will do my best to fix it.
