Quickstart

Quickstart

At any time, if you feel like you're lost, you can execute ./pax --help or ./pax <command> --help to get some information about what you're able to do.

Modpack Creation

• Create a new folder.
• Navigate to the Pax latest release page.
  • If you're using Windows, download the pax-windows.zip file und unzip the contents into your folder.
  • On Linux, simply drop the pax binary into your folder.
• Start a terminal in your created folder.
• Execute ./pax init if you want to start a new modpack, or ./pax import <file> if you want to import an existing one with a given .zip file.

See Getting Started for more information.

Mod Management

Information retrieved from Curseforge is cached locally on disk & updated automatically. To purge the cache, execute ./pax cache purge.

• Install a given mod with the ./pax add <name> command.
  • ./pax add <curseforge-url> or ./pad add <projectid> also works.
• Remove an installed mod with the ./pax remove <name> command.
• Use ./pax ls to display installed mods.
  • A red • next to a mod signifies that the mod is uncompatible.
  • A red ↑ next to a mod signifies that a newer version is available.
• Use ./pax update <name> to update a specific installed mod.
• Use ./pax upgrade to update ALL installed mods.
• Use ./pax pin <name> if you want to pin a mod to its current version so that it won't be updated, ever.
• Use ./pax version <mc-version> to set the Minecraft version of your pack (and update to the recommended loader version).
  • Use ./pax version <mc-version> --latest if you want the latest version instead of the recommended one.
  • Use ./pax remove jumploader & ./pax version <mc-version> --loader fabric to migrate from old Fabric modpacks disguised as Forge modpacks with Jumploader to true Fabric modpacks.

See Mod Management for more information.

Exporting

• Use ./pax export to export your modpack to a .zip file.

See Export for more information.

Automatic Releases

• If you tag a commit with v* (for example v1.0.0 or v2.3.4-alpha), Pax will automatically build your modpack and release it on Github (works out of the box) and Curseforge (some configuration needed).

See Automatic Releases for more information.