Skip to main content

Download and update Minecraft mods from CurseForge and possibly other places in the future.

Project description

minecraft-mod-manager

python Latest PyPI version Downloads Total alerts Language grade: Python

Install and update mods from CurseForge and Modrinth through a simple command.

The GUI Update (late 2022)

There was an idea of adding a GUI to python. Unfortunately, python development is not meant for fast GUI development. So testing changes often requires restarting the application, this is less than ideal especially when I'm used to changing the code and seeing updates directly.

It's one of the reasons the progress stopped on this because it was slow and frustrating.

Thus I started looking for alternatives and found Electron to hopefully be a good fit. This way I can leverage my existing web development skills for creating an GUI instead of learning another. I still want to support a CLI though, but I think this can be done even on servers. It's a main requirement. Of course the new App will be cross platform.

What this means is that I'll start "scratch". But I'd almost have to do that either way with the changes I wanted to do.

Features

  • Install mods with minecraft-mod-manager install mod_name
  • Update all mods with minecraft-mod-manager update, mcman update or mmm update
  • Searches on CurseForge and Modrinth for updates on installed mods
  • Filter updates by
    • Stable (default), beta --beta, or alpha --alpha releases
    • Minecraft version -v 1.16.4
    • Fabric/Forge mod --mod-loader fabric

Installation/Upgrade & Requirements

  1. Requires at least python 3.8
  2. Install/Upgrade with $ pip install --user --upgrade minecraft-mod-manager

Examples

Note! All examples start with minecraft-mod-manager, mcman or mmm (shorthand commands) then comes the arguments.

Arguments Description
install jei Searches for jei on all sites and installs the latest version.
install sodium=modrinth Install Sodium specifically from modrinth.
install dynmap=curse:dynmapforge Install dynmap with slug dynmapforge on Curse.
install sodium=modrinth --mod-loader fabric Install fabric version of sodium. Generally not necessary to specify mod-loader
install carpet fabric-api sodium lithium Easily install many mods.
update Update all mods.
update --pretend Check what will be updated. Does not change anything.
update sodium lithium phosphor Update specific mods.
update -v "1.16.5" Updates to latest mod version which works with specified MC version.
update -v "1.16.1" If you upgraded the mods, to a higher version (e.g. snapshot), you can easily downgrade them again.
configure sodium=modrinth Change the download site for a mod.
configure sodium= Reset download sites (downloads from all sites again)
configure carpet=curse:fabric-carpet Change site slug for a mod.
configure carpet=curse If you don't define a slug, you will reset the slug for that mod.
configure sodium=modrinth carpet=curse Easily configure multiple mods at the same time.
configure carpet=modrinth,curse:fabric-carpet Configure different slugs for different sites.
list List all installed mods.

Full usage

positional arguments:
  {install,update,configure,list}
                        Install, update, configure, or list mods
  mods
                        The mods to update or configure.
                        If no mods are specified during an update, all mods will be updated.
                        You can specify download sites and slugs for each mod (if necessary)
                           dynmap=curse
                           dynmap=curse:dynmapforge
                           dynmap=curse:dynmapforge,modrinth
                           dynmap=curse:dynmapforge,modrinth:dynmap

minecraft:
  -d DIR, --dir DIR     Location of the mods folder. By default it's the current directory
  -v MINECRAFT_VERSION, --minecraft-version MINECRAFT_VERSION
                        Only update mods to this Minecraft version. Example: -v 1.16.4
  --beta                Allow beta releases of mods
  --alpha               Allow alpha and beta releases of mods
  --mod-loader {fabric,forge}
                        Only install mods that use this mod loader. You rarely need to be
                        this specific. The application figures out for itself which type
                        you'll likely want to install.

logging & help:
  -h, --help            show this help message and exit
  --version             Print application version
  --verbose             Print more messages
  --debug               Turn on debug messages
  --pretend             Only pretend to install/update/configure. Does not change anything

Planned features

  • Automatically install dependencies
  • GUI
  • Executable for Windows

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minecraft-mod-manager-1.2.6.tar.gz (58.1 kB view hashes)

Uploaded Source

Built Distribution

minecraft_mod_manager-1.2.6-py3-none-any.whl (53.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page