${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rFunction generateGitignoreRules
- generateGitignoreRules(
lockfile: Lockfile,
workingDir: string,
options?: Options | InitOptions,
): Promise<void>Parameters
- lockfile: Lockfile
The lockfile object
- - workingDir: string
The working directory
- - options: Options | InitOptions = {}
The options object
-
Returns Promise<void>
- lockfile: Lockfile
Function generateJson
- generateJson(
modpackInfo: ModpackInfo,
lockfile: Lockfile,
workingDir: string,
options?: Options | InitOptions,
): Promise<Lockfile>Generate a modpack.json file
-Parameters
- modpackInfo: ModpackInfo
The modpack information
- - lockfile: Lockfile
The lockfile
- - workingDir: string
The path to write the JSON object to
- - options: Options | InitOptions = {}
The options object
-
Returns Promise<Lockfile>
The JSON file's object
- - modpackInfo: ModpackInfo
Function generateLicense
- generateLicense(
modpackInfo: ModpackInfo,
workingDir: string,
options?: InitOptions,
licenseTextOverride?: string,
): Promise<string>Write a license to a file
-Parameters
- modpackInfo: ModpackInfo
The modpack information
- - workingDir: string
The path to write the license to
- - options: InitOptions = {}
The initialization options object
- - licenseTextOverride: string = null
The license text to override the default license text with
-
Returns Promise<string>
The license text or null if the license text could not be generated
- - modpackInfo: ModpackInfo
diff --git a/docs/functions/generateModpackFiles.html b/docs/functions/generateModpackFiles.html
deleted file mode 100644
index 0f51445..0000000
--- a/docs/functions/generateModpackFiles.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
Function generateModpackFiles
- generateModpackFiles(
modpackInfo: ModpackInfo,
workingDir: string,
options?: Options | InitOptions,
): Promise<Lockfile>Generate the modpack files (lockfile, JSON, and optionally license, gitignore, and readme)
-Parameters
- modpackInfo: ModpackInfo
The modpack information
- - workingDir: string
The directory to generate the files in
- - options: Options | InitOptions = {}
The options object
-
Returns Promise<Lockfile>
The lockfile object
- - modpackInfo: ModpackInfo
Function generateReadmeFiles
- generateReadmeFiles(
lockfile: Lockfile,
workingDir: string,
options?: Options | InitOptions,
): Promise<void>Generate the README.md files for each category
-Parameters
- lockfile: Lockfile
The lockfile object
- - workingDir: string
The working directory
- - options: Options | InitOptions = {}
The options object
-
Returns Promise<void>
- lockfile: Lockfile
diff --git a/docs/functions/getModpackInfo.html b/docs/functions/getModpackInfo.html
deleted file mode 100644
index 43662b6..0000000
--- a/docs/functions/getModpackInfo.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
Function getModpackInfo
Get the modpack info from the JSON file if it exists
-Parameters
- directoryPath: string
The path to the directory to scan
-
Returns Promise<ModpackInfo>
The modpack info JSON object if the file exists, otherwise null
-- directoryPath: string
Function promptUserForInfo
Get user input for modpack information
-Parameters
- defaults: ModpackInfo = {}
The initial/default modpack information
-
Returns Promise<ModpackInfo>
The modpack information from the user
-- defaults: ModpackInfo = {}
modpack-lock
Hierarchy Summary
modpack-lock
modpack-lock
-by nickesc - GitHub | Modrinth
-Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks).
-Overview
-Many mod and pack authors request that modpack creators link to Modrinth or CurseForge downloads rather than re-hosting files. This makes it difficult to track content files in version control when pushing to a remote server.
-This script generates a modpack.lock file containing a plaintext representation of the modpack's contents. This object contains the metadata for the content available on Modrinth, including hashes, versions, names, download URLs and more. An optional modpack.json file can also be created to store your modpack's metadata (name, version, modloader, dependencies, etc.) alongside the lockfile. This setup allows for easy diffing and clear version history.
--While an
-.mrpackfile could be used to track changes to the modpack, it is a large, binary file that cannot be diffed and can contain large amounts of duplicate data from the rest of the repository.
Using the scripts field in modpack.json, you can also define reusable, tracked shell commands for common modpack tasks (like publishing, generating assets or CI/CD workflows).
Installation
-To install the script globally with npm:
npm install -g modpack-lock
-Alternatively, you can run it using npx:
npx modpack-lock
-CLI
-To generate a lockfile for your modpack, run:
-modpack-lock
-The script will:
--
-
- Scan target directory's
mods,resourcepacks,datapacks, andshaderpacksdirectories for.jarand.zipfiles
- - Calculate SHA1 hashes for each file -
- Query the Modrinth API for matching versions -
- Generate a
modpack.lockfile (and updatemodpack.jsondependencies if present)
-
Use flags to generate README.md files for each category or update the .gitignore to ignore content hosted on Modrinth.
Usage: modpack-lock [options] [command]
-
-Creates a modpack lockfile for files hosted on Modrinth (mods, resource packs, shaders and datapacks)
-
-Options:
- -p, --path <path> Path to the modpack directory
- -d, --dry-run Dry-run mode - no files will be written
-
-GENERATION
- -g, --gitignore Update the .gitignore file to ignore content hosted on Modrinth
- -r, --readme Generate README.md files for each category
-
-LOGGING
- -q, --quiet Quiet mode - only show errors and warnings
- -s, --silent Silent mode - no output
-
-INFORMATION
- -V output the version number
- -h, --help display help for modpack-lock
-
-Commands:
- init [options] This utility will walk you through creating a modpack.json file. It only covers the most common items, and tries to guess sensible defaults.
- run [options] <script> Run a script defined in the modpack.json file's 'scripts' field
-Tip
-Did you know?
-You can generate summary files for each category by running modpack-lock -r. This will generate a README.md file in each of the content folders, detailing the scanned files and important attribution information for them.
Initialization
-To initialize a new modpack, run:
-modpack-lock init
-This command will:
--
-
- Prompt the user for the modpack's metadata (name, version, author, etc.) -
- Generate the lockfile -
- Generate a
modpack.jsonfile that stores your modpack's metadata (name, version, author, etc.), including a list of dependencies
-
The interactive mode will prompt you for each field. Set their initial values using the available option flags. Use --noninteractive with the required options to skip the interactive-prompt and use the provided values.
Usage: modpack-lock init [options]
-
-This utility will walk you through creating a modpack.json file. It only covers the most common items, and tries to guess sensible defaults.
-
-Options:
- -f, --folder <path> Path to the modpack directory
- -n, --noninteractive Non-interactive mode - must provide options for required fields
- --add-license Add the LICENSE file to the modpack
- --add-gitignore Update the .gitignore file to ignore content hosted on Modrinth
- --add-readme Generate README.md files for each category
-
-MODPACK INFORMATION
- --name <name> Modpack name; defaults to the directory name
- --version <version> Modpack version; defaults to 1.0.0
- --id <id> Modpack slug/ID; defaults to the directory name slugified
- --description <description> Modpack description
- --author <author> Modpack author; required
- --projectUrl <projectUrl> Modpack URL; defaults to a guessed Modrinth project URL
- --sourceUrl <sourceUrl> Modpack source code URL; defaults to a guessed GitHub repository URL
- --license <license> Modpack license, popular licenses fetched from GitHub; defaults to MIT in interactive mode
- --modloader <modloader> Modpack modloader, list of loaders fetched from Modrinth; required
- --targetModloaderVersion <targetModloaderVersion> Target modloader version
- --targetMinecraftVersion <targetMinecraftVersion> Target Minecraft version, list of versions fetched from Modrinth; required
-
-INFORMATION
- -h, --help display help for modpack-lock init
-Running Scripts
-To run a script defined in modpack.json, run:
modpack-lock run <script>
-This command takes the name of the script as its first argument:
--
-
- It searches for a scripts fiels in
modpack.jsonin the current directory by default.
- - Use the
-foption to specify a different path to the modpack directory.
- - For debug logging, use the
-Doption.
-
--To pass additional arguments and options to the script, write them after a
---separator:- -modpack-lock run <script> -- [options] <args> -
The scripts field in modpack.json is a key-value pair of script names and their corresponding shell commands. The scripts field is optional and is omitted by default.
Usage: modpack-lock run [options] <script>
-
-Run a script defined in the modpack.json file's 'scripts' field
-
-Arguments:
- script The name of the script to run
-
-Options:
- -f, --folder <path> Path to the modpack directory
- -D, --debug Debug mode -- show more information about how the command is being parsed
-
-INFORMATION
- -h, --help display help for modpack-lock run
-API
-For programmatic usage, modpack-lock exports these functions:
-
-
getModpackInfo()
-getLockfile()
-generateJson()
-generateGitignoreRules()
-generateReadmeFiles()
-generateLicense()
-generateLockfile()
-generateModpackFiles()
-promptUserForInfo()
-
See the API documentation for full details.
-File Formats
-modpack.lock
-The lockfile contains metadata about Modrinth-hosted files found in modpack directories:
-{
"version": "1.0.1",
"generated": "2026-01-06T03:00:00.000Z",
"total": 7,
"counts": {
"mods": 1,
"resourcepacks": 3,
"datapacks": 1,
"shaderpacks": 2
},
"dependencies": {
"mods": [
{
"path": "mods/example-mod.jar",
"version": { ... }
}
],
"resourcepacks": [ ... ],
"datapacks": [ ... ],
"shaderpacks": [ ... ]
}
}
-modpack.json
-The JSON file contains your modpack metadata and a dependency list:
-{
"name": "My Modpack",
"version": "1.0.0",
"id": "my-modpack",
"description": "",
"author": "name",
"projectUrl": "",
"sourceUrl": "",
"license": "",
"modloader": "modloader",
"targetModloaderVersion": "",
"targetMinecraftVersion": "x.y.z",
"scripts": {
"example": "echo 'example script'"
},
"dependencies": {
"mods": [ ... ],
"resourcepacks": [ ... ],
"datapacks": [ ... ],
"shaderpacks": [ ... ]
}
}
-Important
-Don't commit binaries
-Use modpack-lock -g to automatically update your .gitignore file with rules to ignore modpack contents, with exceptions for any files that are not hosted by Modrinth:
# .gitignore
-
-# modpack-lock:start
-mods/*.jar
-resourcepacks/*.zip
-datapacks/*.zip
-shaderpacks/*.zip
-*/**/*.disabled
-
-## Exceptions
-!mods/example.jar
-# modpack-lock:end
-This section is managed by modpack-lock and will be updated automatically when you run modpack-lock -g. Changes made inside this section will be overwritten, but any changes you make outside of this section will be preserved.
License
-This project is licensed under the MIT License - see the LICENSE file for more details.
-
Interface InitOptions
Contains options for the initialization of the modpack files.
-interface InitOptions {
folder: string;
noninteractive: boolean;
addLicense: boolean;
addGitignore: boolean;
addReadme: boolean;
name: string;
version: string;
id: string;
description: string;
author: string;
projectUrl: string;
sourceUrl: string;
license: string;
modloader: string;
targetModloaderVersion: string;
targetMinecraftVersion: string;
_init: boolean;
}
folder: string;
noninteractive: boolean;
addLicense: boolean;
addGitignore: boolean;
addReadme: boolean;
name: string;
version: string;
id: string;
description: string;
author: string;
projectUrl: string;
sourceUrl: string;
license: string;
modloader: string;
targetModloaderVersion: string;
targetMinecraftVersion: string;
_init: boolean;
}
Index
Properties
Properties
folder
folder: string
The folder to generate the modpack files in
-noninteractive
noninteractive: boolean
Whether to run the interactive mode
-add
addLicense: boolean
Whether to add the license file to the modpack
-add
addGitignore: boolean
Whether to generate .gitignore rules
-add
addReadme: boolean
Whether to generate README.md files
-name
name: string
The name of the modpack
-version
version: string
The version of the modpack
-id
id: string
The slug/ID of the modpack
-description
description: string
The description of the modpack
-author
author: string
The author of the modpack
-project
projectUrl: string
The modpack's project URL
-source
sourceUrl: string
The modpack's source code URL
-license
license: string
The modpack's license
-modloader
modloader: string
The modpack's modloader
-target
targetModloaderVersion: string
The target modloader version
-target
targetMinecraftVersion: string
The target Minecraft version
-_
_init: boolean
Internal boolean added to indicate options come from the init command.
Interface Lockfile
Contains information about the modpack dependencies and their versions.
-interface Lockfile {
version: string;
generated: string;
total: number;
counts: {
mods: number;
resourcepacks: number;
datapacks: number;
shaderpacks: number;
};
dependencies: {
mods: any[];
resourcepacks: any[];
datapacks: any[];
shaderpacks: any[];
};
}
version: string;
generated: string;
total: number;
counts: {
mods: number;
resourcepacks: number;
datapacks: number;
shaderpacks: number;
};
dependencies: {
mods: any[];
resourcepacks: any[];
datapacks: any[];
shaderpacks: any[];
};
}
Index
Properties
Properties
version
version: string
The version of the modpack
-generated
generated: string
The date and time the lockfile was generated
-total
total: number
The total number of files in the modpack
-counts
counts: {
mods: number;
resourcepacks: number;
datapacks: number;
shaderpacks: number;
}
mods: number;
resourcepacks: number;
datapacks: number;
shaderpacks: number;
}
The counts object
-Type Declaration
mods: number
The mods count
-resourcepacks: number
The resourcepacks count
-datapacks: number
The datapacks count
-shaderpacks: number
The shaderpacks count
-
dependencies
dependencies: {
mods: any[];
resourcepacks: any[];
datapacks: any[];
shaderpacks: any[];
}
mods: any[];
resourcepacks: any[];
datapacks: any[];
shaderpacks: any[];
}
The dependencies object
-Type Declaration
mods: any[]
The mods object
-resourcepacks: any[]
The resourcepacks object
-datapacks: any[]
The datapacks object
-shaderpacks: any[]
The shaderpacks object
-
Interface ModpackInfo
Contains information about the modpack that is not dependent on the lockfile.
-interface ModpackInfo {
name: string;
version: string;
description: string;
id: string;
author: string;
projectUrl: string;
sourceUrl: string;
license: string;
modloader: string;
targetModloaderVersion: string;
targetMinecraftVersion: string;
}
name: string;
version: string;
description: string;
id: string;
author: string;
projectUrl: string;
sourceUrl: string;
license: string;
modloader: string;
targetModloaderVersion: string;
targetMinecraftVersion: string;
}
Index
Properties
Properties
name
name: string
The name of the modpack (Required)
-version
version: string
The version of the modpack (Required)
-description
description: string
The description of the modpack
-id
id: string
The slug/ID of the modpack (Required)
-author
author: string
The author of the modpack (Required)
-project
projectUrl: string
The project URL of the modpack
-source
sourceUrl: string
The source code URL of the modpack
-license
license: string
The license of the modpack
-modloader
modloader: string
The modloader of the modpack (Required)
-target
targetModloaderVersion: string
The target modloader version of the modpack
-target
targetMinecraftVersion: string
The target Minecraft version of the modpack (Required)
-Interface Options
Contains options for the generation of the modpack files.
-interface Options {
dryRun: boolean;
quiet: boolean;
silent: boolean;
gitignore: boolean;
readme: boolean;
licenseFile: boolean;
}
dryRun: boolean;
quiet: boolean;
silent: boolean;
gitignore: boolean;
readme: boolean;
licenseFile: boolean;
}
Properties
dry
dryRun: boolean
Whether to dry run the generation
-quiet
quiet: boolean
Whether to quiet the console output
-silent
silent: boolean
Whether to silent the console output
-gitignore
gitignore: boolean
Whether to generate a .gitignore file
-readme
readme: boolean
Whether to generate README.md files
-license
licenseFile: boolean
Whether to generate a license file
-
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
deleted file mode 100644
index 684c124..0000000
--- a/docs/sitemap.xml
+++ /dev/null
@@ -1,67 +0,0 @@
-
-
Generate .gitignore rules for files not hosted on Modrinth and write them to .gitignore file
-