Command-line Minecraft mod manager
Project description
Carrot is a command-line interface for managing Minecraft mods in an MC instance.
It uses an API that indexes all mods and files on CurseForge.
Installation
From PyPI
Carrot is published on PyPI,
therefore the best way to install it is via pip
:
pip install carrot-mc
This assumes you're installing it in a virtualenv environment.
If you're installing it globally on Linux, you'll probably need to prepend
the above command with sudo
.
From source
You can also download and build your own copy straight from source:
git clone https://github.com/Misza13/carrot
cd carrot
python setup.py install
Usage
Important notes:
- All commands operate in the current directory and assume that you're
currently in the
mods/
directory of your Minecraft instance. - Mods are referred to by their "key", which is the string as it is used
in CurseForge URLs, e.g. for
"Tinkers' Construct"
mod, it's
tinkers-construct
.
To get general help about the program, simply type
carrot
without any arguments (or just -h
or --help
) to see all available commands.
To get help on a specific command, run e.g.
carrot install -h
Additional pointers on some of the commands follow.
init
- initialize the mod repository
Before any usage, you must initialize a mod repository and select the Minecraft version of this instance, e.g.:
carrot init --mc_version 1.12.2
This will create a mods.json
file in the current directory that will hold
information on the installed mods.
Be aware that this will initialize the repository aligned with the Beta
channel
on CurseForge. To use a different channel, use the --channel
command, e.g.:
carrot init --mc_version 1.12.2 --channel Release
The channel determines the stability of mod releases that you wish to receive.
Beta
is a good default and you may manually override it in other commands
using the same option.
install
- install a mod
If you know the exact key of the mod, install it in the current directory using
carrot install jei
The above example would install the mod "Just Enough Items" because jei
is
its exact key name. Note that it will use Minecraft version and channel
settings from mods.json
. The channel can be overridden:
carrot install jei --channel Release
If there is no mod that matches exactly what you've typed, e.g.
carrot install applied
you will be presented with a list of top-downloaded mods that have applied
in their key (presumably related to Applied Energistics 2 mod).
Stay tuned for a planned carrot search
command that will allow to search
in names and descriptions of mods.
install
pulls dependencies, if there are any, e.g.
carrot install tinkers-construct
will install both Tinkers' Construct itself as well as "Mantle", the library dependency.
In case of conflicts (e.g. different versions of dependencies either due to
updates or pulling mods from different channels), Carrot will leave already
installed files untouched (to ensure that nothing that already worked breaks),
but you can override this behaviour with --upgrade
and --downgrade
flags
(see carrot install -h
for details). Carrot will verbosely inform you if
this happens, so do pay attention to its output.
update
- update mod(-s) to newer/older versions
In its simplest form:
carrot update
Carrot will attempt to update all currently installed mods (along with their dependencies) to their newest versions.
Note: As of now, Carrot does not "sticky" the channel of a mod, so if
you installed a mod explicitly in the Release
channel, but the default
in mods.json
is Beta
, the default update
will update that mod to
Beta
(unless the newest available file is in Release
channel).
You can request only a single mod (with dependencies) to be updated with:
carrot update rftools
Additionally, you can force a target channel with --channel
option,
which can cause mods to go both up as well as down in versions.
Similarly to install
, you must explicitly allow --downgrade
if
you want older versions of mods to be installed. However, unlike
during installation, the equivalent of --upgrade
is "always on".
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for carrot_mc-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e4cf8f1d6d335b63c5f7c420118d6b190141a7bf984201f8159db06dd75a3c8 |
|
MD5 | 5f619644bd7c57387e94de5b774e5ced |
|
BLAKE2b-256 | 1e1a16567f53b3ef3347772220ecd82e664b76b44f73729b083e1f6b8f49624c |