@nexora-studios/mrpack.ts

Features

Prerequisites

Installation

# Using npm
npm install @nexora-studios/mrpack.ts
# Using pnpm
pnpm add @nexora-studios/mrpack.ts
# Using yarn
yarn add @nexora-studios/mrpack.ts

Dependencies

Usage

Basic Example

import { MrpackBuilder, IndexJson, IndexJsonFile, Override } from '@nexora-studios/mrpack.ts';
// Create index metadata
const indexJson = new IndexJson(
 'My Mod Pack',
 '1.0.0',
 { minecraft: '1.19.2', 'fabric-loader': '0.14.9' },
 'A cool mod pack'
);
// Add a file to the index
const modFile = new IndexJsonFile(
 'mods/modid-1.0.0.jar',
 'sha1hash',
 'sha512hash',
 123456 // file size in bytes
);
modFile.addDownloadUri('https://example.com/mods/modid-1.0.0.jar');
indexJson.addFile(modFile);
// Create a builder with the index
const builder = new MrpackBuilder(indexJson.marshaledJson);
// Add an override file
const configOverride = new Override('config/config.json', 'json');
configOverride.content = { setting1: 'value1', setting2: 'value2' };
builder.addOverride(configOverride);
// Build the mrpack file
const mrpackBuffer = await builder.build();
// Now you can write mrpackBuffer to a file

Components

IndexJson

const indexJson = new IndexJson(name, version, dependencies, summary?);
indexJson.addFile(file);
const marshaled = indexJson.marshaledJson;

IndexJsonFile

const file = new IndexJsonFile(path, sha1, sha512, fileSize);
file.addDownloadUri(uri);
const marshaled = file.marshaledJson;

Override

const override = new Override(filePath, fileType); // fileType can be 'json', 'toml', 'string', or 'buffer'
override.content = content;

MrpackBuilder

const builder = new MrpackBuilder(indexJson);
builder.addOverride(override);
const buffer = await builder.build();

Development Guide

Scripts

# Build the project
pnpm run build
# Run tests
pnpm test
# Watch mode for development
pnpm run dev

Project Structure

├── src/
│ ├── components/ # Reusable components
│ │ ├── IndexJson.ts # Mod pack metadata handling
│ │ ├── IndexJsonFile.ts # File entry in mod pack index
│ │ ├── Override.ts # Override file handling
│ │ └── index.ts # Component exports
│ ├── lib/ # Core library functionality
│ │ ├── managers/ # Component managers
│ │ ├── package/ # Package system
│ │ └── mrpack/ # mrpack-specific code
│ ├── types/ # Type definitions
│ └── index.ts # Main entry point
├── tests/ # Test files
├── dist/ # Compiled output
├── package.json # Project configuration
├── tsconfig.json # TypeScript configuration
├── jest.config.js # Jest configuration
├── .npmrc # pnpm configuration
└── .gitignore # Files to ignore in Git

TypeScript Support

License

Author