Skip to content

Latest commit

 

History

History
89 lines (72 loc) · 2.24 KB

README.md

File metadata and controls

89 lines (72 loc) · 2.24 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.


Downloading and running - Linux & Windows

To use cursely you need a Curseforge API key.

Open a Terminal (Linux) or Command Prompt (Windows) and paste the following commands:

pip3 install requests numerize prettytable
git clone https://github.com/julynx/cursely
cd cursely
python cursely --help

Installing to system path - Linux

Open a Terminal inside the cursely folder and paste the following commands:

sudo chmod +x cursely*
sudo cp cursely* /usr/bin

You can now run cursely from anywhere with the cursely command.


Usage

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.
cursely --help      Show this help message.

Modpacks

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

example_modpack.mods

  # Comment
  $ Shell command
  @ https://manual_mod_download_url...
  # [mod_id] [mod_name]
  12345 Mod name
  67890 Mod name
  ...

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.

Uninstalling

To uninstall cursely, simply remove the installation folder and the executables from the system path.