Skip to content

Latest commit

 

History

History
123 lines (87 loc) · 5.43 KB

readme.md

File metadata and controls

123 lines (87 loc) · 5.43 KB
Raw

pacmc

pacmc is a package manager (and soon to be launcher) for Minecraft mods.

The aim of this project is to massively reduce the effort that goes in to installing - and most importantly - keeping your mods up to date. Install Fabric, Quilt and Forge mods from Modrinth and Curseforge!

To install pacmc, visit the Installation section.

The current version of pacmc is already pretty useful and works, however keep an eye on this project, as it will receive major new features and improvements in the near future!

You can chat and ask questions on Matrix (or Discord).

Support for the new Curseforge API is in development!

Contributions for the following things will be very welcome:

  • an icon for pacmc
  • an OpenGL 3D skin renderer

Usage

The main command is pacmc. You can add -h to any command to get help.

Command overview

Commands:
  search   Search for mods
  archive  Manage archives
  install  Install content to an archive
  remove   Remove content from an archive
  update   Update content installed to an archive
  list     List content installed to an archive
  refresh  Refresh an archive and all content installed to it

Quick start

After you have installed pacmc, you start as follows:

# add the .minecraft folder as an archive
pacmc archive init
# search for mods
pacmc search sodium
# install a mod
pacmc install lithium

Archives

Archives are the places (folders) where your mods are stored. Your .minecraft/mods folder is the default archive, but you can add more (for example to manage mods on a server, which pacmc is designed for as well).

Init the default archive

To add the .minecraft/mods folder as an archive:

pacmc archive init

Add an archive

To add a custom folder as an [Fabric|Forge|Quilt] archive:

pacmc archive create --loader fabric myarchive ./path/to/my/archive

List all existing archives

pacmc archive list

Remove an archive

pacmc archive remove myarchive

Search for mods

pacmc search sodium
# or
pacmc search "Fabric API"

Install a mod

pacmc install iris

or to a specific archive:

pacmc install 447425 -a myarchive

Installation

Platform Instructions Location Package Manager
Arch Linux and Manjaro install using an AUR helper
e.g. paru pacmc		 pacmc in AUR any AUR helper
macOS or any Linux distro brew install pacmc pacmc in homebrew-core Homebrew
any Linux distro flatpak install net.axay.pacmc coming soon, definitely with gui Flatpak
NixOS or any Linux distro coming soon coming soon NixOS
Windows (scoop bucket add games)
scoop install pacmc		 pacmc in scoop-games scoop
Windows (gui only) Install pacmc from the Microsoft Store considered for gui Microsoft Store
Windows winget install pacmc postponed, only supports legacy installers winget

Other

If the installation methods above don't fit your needs, you can also install pacmc manually. Keep in mind though, that this way pacmc won't receive updates automatically.

Download one of the released archives from the releases page. Extract the archive. Inside there will be a bin directory. Run the shell script using ./pacmc.