Install and run

Running Modpack-Changelogger

PIP package

Note: Ensure that Python 3.10+ and pip are installed.

1. Install the package

pip install modpack-changelogger 

2. Run it (you might need to restart the shell)

modpack-changelogger --old_path path/to/old/pack --new_path path/to/new/pack

Tip

You can also run ModpackChangelogger in your Python script!

from modpack-changelogger import generate_changelog
generate_changelog(old_path, new_path, config_path, changelog_file)  # Last two are optional

.Py Script

Note: Ensure that Python 3.10+ is installed.

1. Download the .zip or .tar.gz file from the latest release.

2. Extract the archive and open a terminal in the 'src' folder inside it.

3. Install the dependencies with:

   pip install -r requirements.txt

4. Execute the script.

   python ModpackChangelogger.py [args]

   Example:

   python ModpackChangelogger.py --old_path path/to/old/pack --new_path path/to/new/pack

On Windows exe wrapper

1. On GitHub, Navigate to the latest release.

2. Download the Windows build from the release tab.

3. Open PowerShell or Command Prompt.

4. Change the directory to where the downloaded file is located.

   cd \path\to\downloaded\file

5. Execute the program.

   .\ModpackChangelogger.exe [args]