Packwiz for Deno

An ergonomic Deno wrapper around the CLI tool packwiz, used to create and manage Minecraft modpacks.

Table of Contents

• Getting Started
  • Project Initialization
• Scripts
  • Install Packwiz Executable
  • Development and Playtesting with MultiMC
• Type Definitions
• Project Scope

Getting Started

In a Deno project, with packwiz available on your PATH:

import { Pack } from "https://deno.land/x/packwiz@0.1.0/mod.ts";

const pack = new Pack("path/to/pack/directory");

await pack.add("curseforge", "quark"); // creates mods/quark.pw.toml
console.log(pack.mods.quark); // contents of mods/quark.pw.toml
await pack.update("quark"); // updates mods/quark.pw.toml
await pack.remove("quark"); // removes mods/quark.pw.toml

See the API docs for more information.

Project Initialization

Generally you will want to initialize a new project with packwiz CLI, which guides you through the process:

packwiz init

This library also provides a standalone function to use the CLI programmatically:

import { initialize } from "https://deno.land/x/packwiz@0.1.0/mod.ts";

initialize({
  author: "me",
  name: "my modpack",
  minecraftVersion: "1.18.2",
  modLoader: "Forge",
  rootDir: "./temp",
  exePath: "./packwiz",
});

Scripts

Install Packwiz Executable

To download the latest version of packwiz, run this in your project directory:

deno run -A https://deno.land/x/packwiz@0.1.0/install.ts

You can also provide a directory path install elsewhere:

deno run -A https://deno.land/x/packwiz@0.1.0/install.ts /path/to/directory

Development and Playtesting with MultiMC

Packwiz provides a unique method of playtesting modpacks by creating a MultiMC instance that is automatically updated with the latest version of your modpack, allowing you to test your modpack without having to manually update it every time you make a change.

A script is provided to streamline and walk you through the process. In your project directory, run:

deno run -A https://deno.land/x/packwiz@0.1.0/dev.ts

You can also provide a path to a packwiz project as an argument:

deno run -A https://deno.land/x/packwiz@0.1.0/dev.ts /path/to/packwiz/project

Type Definitions

import type { MetaFile } from "https://deno.land/x/packwiz@0.1.0/mod.ts";

Types are also re-exported under the Pack namespace, which is merged with the main Pack class. This allows you to keep your imports very clean, and in more complex files it contextualizes type names for ease of comprehension.

import { Pack } from "https://deno.land/x/packwiz@0.1.0/mod.ts";

const pack = new Pack("path/to/pack");

const curseForgeMods = Object.values(pack.mods)
  .filter((file): file is Pack.CurseForgeMetaFile =>
    "curseforge" in file.update
  );

Project Scope

Given const pack = new Pack() for brevity: