Getting started

Creating your modpack

The first thing you wanna do with pax is choosing a location where you will store your modpack. Create a new folder and drop your downloaded version of Pax in there, so your directory structure looks like this:

yourcreatedfolder/
└── pax (or pax.exe under Windows)

Depending on whether you'd like to start fresh or already have a modpack you'd like to edit, there are two actions you can take:

• If you want to create a new modpack, execute the ./pax init command.
  • Pax will ask to confirm your action and to choose your modpack name, the name of the author, the modpack version (can be any version number, for example 1.0.0) and the minecraft version (the version this pack is compatible with).
• If you already have a modpack you'd like to modify, execute the ./pax import <file> command.
  • Replace <file> with a location to your .zip file, for example ./pax import C:\Downloads\All_The_Mods_6.zip.
  • For importing, only .zip files in the Curseforge modpack structure are accepted. .zip files that contain complete minecraft profiles or *.jar files are unsupported.

Regardless if you chose initialization or import, this is what your directory structure should look like now:

yourcreatedfolder/
├── modpack/
│   ├── overrides/
│   └── manifest.json
└── pax (or pax.exe under Windows)

If you've opened or unzipped a modpack from Curseforge before, you've surely noticed that pax's directory structure in modpack/ is completely identical to theirs. Pax is designed to be easy to use with the existing Curseforge structure, which means that even if the ./pax export command fails or the sun goes dark, you would still be able to manually create your modpack by zipping the contents of the modpack/ folder.

How to go from here

Pax has a comprehensive command reference viewable by ./pax --help or ./pax <command> --help.

• Judging from the fact that you have a modpack with 0 mods in it, you probably want to add some.
  • Use ./pax add <modname> to search for a mod with the given name and add it.
  • Use ./pax ls command to view currently installed mods.
  • Use ./pax remove <modname> to search for an installed mod with the given name and uninstall it.
• Since mods are constantly being updated, pax is also able to watch for updates and install them.
  • Use ./pax update <modname> to search for an installed mod with the given name and update it to the newest compatible version.
  • Use ./pax upgrade to update ALL installed mods to their newest compatible version.
• In order to get your pack out into the world, you'll need to export it to a .zip file.
  • Use ./pax export for that. The .zip file you'll find in .out/ can be uploaded to Curseforge or used in any launcher that supports importing .zip files.