Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Senth/minecraft-mod-manager
Install and update mods from CurseForge and Modrinth through a CLI
https://github.com/Senth/minecraft-mod-manager
cli curseforge minecraft modrinth mods
Last synced: 14 days ago
JSON representation
Install and update mods from CurseForge and Modrinth through a CLI
- Host: GitHub
- URL: https://github.com/Senth/minecraft-mod-manager
- Owner: Senth
- License: mit
- Created: 2020-11-08T16:14:45.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T01:38:58.000Z (8 months ago)
- Last Synced: 2024-04-20T13:13:56.970Z (8 months ago)
- Topics: cli, curseforge, minecraft, modrinth, mods
- Language: Python
- Homepage:
- Size: 2.09 MB
- Stars: 74
- Watchers: 9
- Forks: 6
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-modding - mcman - CLI Modrinth mod manager. (Minecraft / Cyberpunk 2077 / REDEngine 4)
README
# mcman/mmm (minecraft-mod-manager)
[](https://pypi.python.org/pypi/minecraft-mod-manager)
[](https://pypi.python.org/pypi/minecraft-mod-manager)
[](https://lgtm.com/projects/g/Senth/minecraft-mod-manager/alerts/)
[](https://lgtm.com/projects/g/Senth/minecraft-mod-manager/context:python)
Install and update mods from ~~CurseForge~~ and Modrinth through a simple command.
## News — Slow progress and an Alternative CLI (2022-08-02)
Hi everyone!
I have acquired a CurseForge API key, but still want to make it easy to install mods from CurseForge
without applying for a key.
Maybe that's not possible, but I have some ideas at least for improving `mcman`.
This includes downloading mods from CurseForge.
For now though, I can point you to an awesome and in my opinion, better alternative: [ferium](https://github.com/gorilla-devs/ferium).
Cheers,
Senth
_[(News Archive)](./NEWS.md)_
## 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
1. 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=` | Doesn't work, known bug! 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
```none
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
--no-color Disable color output
```
## Alternatives
### GUI
- [Overwolf](https://www.overwolf.com/)
- [kaniol-lck/modmanager](https://github.com/kaniol-lck/modmanager)
- [ReviversMC/modget-minecraft](https://github.com/ReviversMC/modget-minecraft)
- [4JX/mCubed](https://github.com/4JX/mCubed)
### CLI
- [gorilla-devs/ferium](https://github.com/gorilla-devs/ferium)
- [sargunv/modsman](https://github.com/sargunv/modsman)
- [tyra314/modweaver](https://github.com/tyra314/modweaver)
## Authors
- Matteus Magnusson, [email protected]