Skip to content

Latest commit

 

History

History
96 lines (74 loc) · 2.91 KB

README.md

File metadata and controls

96 lines (74 loc) · 2.91 KB
Raw

cursely

Cross-platform mod management for Minecraft.


Browse recently updated mods.


Search for mods by name and author.


View mod details and get dependencies and download links.


Automatically deploy a modpack and its configs.


Installation

To use cursely you need a Curseforge API key.

The first step is to install the required dependencies:

pip3 install requests prettytable numerize

Then, clone the repository and install the executable files:

git clone https://github.com/julynx/cursely /tmp/cursely
sudo chmod +x /tmp/cursely/cursely*
sudo cp /tmp/cursely/cursely* /usr/bin

Usage

Cursely will ask for your Minecraft version, loader (Fabric or Forge), and API key when you run it for the first time, and will save those settings to .config/cursely/config.json. From now on, it will only show mods compatible with that configuration.

You can now run the cursely command followed by any of the arguments listed below:

  cursely             Browse popular recently updated mods.
  cursely [MOD_ID]    Get a brief description of a mod and its download link.
  cursely [KEYWORD]   Search for a mod by its name or author.
  cursely [MODPACK]   Install all listed mods and their dependencies.

Modpacks

A modpack file is a plain text file with the .mods extension and the following format:

example_modpack.mods

  # This line is a comment and will be ignored
  $ This is a bash command that will be executed
  12345 Name of mod
  67890 Name of mod
  ...

Running cursely example_modpack.mods will:

  1. Download and install the listed mods.
  2. Download and install their required dependencies.
  3. Execute all the commands specified in the file.
  4. Print any errors that might have occurred.

You can also use the cursely_modpack command, followed by the name of a modpack file (minus the extension) hosted in this repository to retrieve and deploy it.

For example, cursely_modpack magical_souls will fetch and install the modpack file github.com/julynx/cursely/magical_souls.mods.


Uninstalling

To uninstall cursely, delete the executables and the configuration using the command:

sudo rm -rf /usr/bin/cursely* ~/.config/cursely

Notes

If you are a Windows user, check out the multiplatform beta (W.I.P.).