mirror of
https://github.com/packwiz/packwiz.git
synced 2025-04-19 13:06:30 +02:00
packwiz
A command line tool for creating minecraft modpacks.
Installation
In future I will have a lot more installation options, but for now the easiest way is to compile from source.
- Install Go (1.13 or newer)
- Clone or download the repository (
git clone https://github.com/comp500/packwiz
), and open the folder in a terminal - Run
go install .
to put it on your path, orgo build
to just make a binary. Be patient, it has to download and compile dependencies as well!
Getting Started
- Run
packwiz init
to create a modpack in the current folder - Run
packwiz curseforge import [zip path]
to import from a Twitch modpack - Run
packwiz refresh
to update the index of mods - Run
packwiz curseforge install [mod]
to install a mod from CurseForge - Run
packwiz update [mod]
to update a mod - Run
packwiz update --all
to update all the mods in the modpack - Run
packwiz curseforge export
to export the modpack in the format supported by the Twitch Launcher - Run
packwiz serve
to start a local HTTP server running the pack - which packwiz-installer can install from - Run
packwiz curseforge detect
to detect files that are available on CurseForge and make them downloaded from there - Use the
--help
flag for more information about any command - Use packwiz-installer as a MultiMC prelaunch task for auto updating, optional mods and side-only mods!
Resources
- See https://suspicious-joliot-f51f5c.netlify.app/index.html for some documentation
- I am in the process of rewriting the format, so there may be information there that is outdated
- See https://github.com/Fibercraft/Temporary-Modpack for an example of an existing modpack using packwiz
- This repository can be published to a service like Github Pages or Netlify and installed using packwiz-installer
- This repository also shows the use of
.gitattributes
and.packwizignore
to disable line ending modification (so that the hashes are correct) and ignore git-specific files
Tips
- There are some useful aliases, like
packwiz cf
=>packwiz curseforge
- The
packwiz cf install
command supports multiple formats:packwiz cf install sodium
(by slug)packwiz cf install https://www.curseforge.com/minecraft/mc-mods/sodium
(by mod page URL)packwiz cf install https://www.curseforge.com/minecraft/mc-mods/sodium/files/3067101
(by file page URL)packwiz cf install Sodium
(by search)packwiz cf install --addon-id 394468 --file-id 3067101
(if all else fails)
- If files aren't being found, try running the
packwiz refresh
command to update the index!
Languages
Go
98.1%
Nix
1.3%
HTML
0.6%