@scml/mod-diff3-way-merge

TypeScript type definitions for Three-way merge, performing 3-way merge (base + ours + theirs) on mod patches.

Installation

npm
yarn
pnpm
bun
deno
npm install -D @scml/mod-diff3-way-merge

Quick Start

Add type reference

/// <reference types="@scml/mod-diff3-way-merge" />

Use global instance

diff3WayMerge is mounted on window.

Global Types global

PropertyTypeDescription
diff3WayMergeDiff3WayMerge3-way merge Addon instance

Subpath Exports

SubpathDescription
.Main entry
./Diff3WayMergeMain class
./Diff3WayMergeParamsMerge params
./DiffFormatDiff format
./diff_match_patch/diff_match_patchdiff-match-patch library

API Reference

Diff3WayMerge class

Property/MethodDescription
infoMap<string, ModMergeInfo>
registerMod()Register mod
afterPatchModToGame()After patch hook
do_patch()Execute merge
readOriginFile() / readModFile() / readDiffFormatFile()Read files

ModMergeInfo interface

{ addonName, mod, modZip }

Type Definition Source

INFO