packwiz/README.md
2020-07-12 23:06:36 +01:00

2.2 KiB

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.

  1. Install Go
  2. Clone or download the repository (git clone https://github.com/comp500/packwiz), and open the folder in a terminal
  3. Run go install . to put it on your path, or go 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
  • 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

Things that are broken

  • The CurseForge API is currently broken, so for 1.16/1.16.1 mods
    • You need to specify the URL directly when installing e.g. packwiz cf install https://www.curseforge.com/minecraft/mc-mods/motiono/files/2983176
    • The update command may not find a new version properly