packwiz-nxt

README

packwiz-nxt

This is a refactored packwiz/packwiz. This repo focuses on changing the codebase so that packwiz can be used as a library without needing to write to the file system. The original CLI functionality is mostly maintained.

Curseforge

This fork does not include a Curseforge API key in its source code. You can apply for one here. You must supply it with one of these methods:

• if building the project locally, include the ldflag -X 'main.CfApiKey=<base64-encoded-key>'
  • using the make file: CF_API_KEY=<base64-encoded-key> make
• if using as a library, call config.SetCurseforgeApiKey(<base-64-encoded-key>) at some point in your code

GitHub

This fork does not include a GitHub API key in its source code. You can supply it with these methods do avoid being rate limited:

• if building the project locally, include the ldflag -X 'main.GhApiKey=<key>'
  • using the make file: GH_API_KEY=<key> make
• if using as a library, call config.SetGitHubApiKey(<key>) at some point in your code

---

From the original repo:

packwiz is a command line tool for creating Minecraft modpacks. Instead of managing JAR files directly, packwiz creates TOML metadata files which can be easily version-controlled and shared with git (see an example pack here). You can then export it to a CurseForge or Modrinth modpack, or use packwiz-installer for an auto-updating MultiMC instance.

---

Development

Local development is facilitated through the make file and its commands.

# development build
$ make

# tests
$ make test

# lint and autoformat
$ make lint
$ make fmt