@scml/sc2-modloader

TypeScript type definitions for SugarCube 2 Mod Loader, providing type support for mod and game data management.

Installation

npm

yarn

pnpm

bun

deno

npm install -D @scml/sc2-modloader

Quick Start

Add type reference

Add triple-slash directive in your project to bring in global types:

/// <reference types="@scml/sc2-modloader" />

Use global objects

Mod Loader mounts core objects on window; access directly:

window.modSC2DataManager;   // Data manager
window.modUtils;            // Mod utilities
window.modAddonPluginManager; // Addon plugin manager

Import types on demand

import type { ModInfo, ModLoader } from '@scml/sc2-modloader/ModLoader';
import type { AddonPluginHookPointEx } from '@scml/sc2-modloader/AddonPlugin';

Global Types global

Main entry extends Window via /// <reference types="..." />. global The following properties are on window:

Property	Type	Description
`jQuery` / `$`	`JQueryStatic`	jQuery instance
`modSC2DataManager`	`SC2DataManager`	Mod and game data manager
`modUtils`	`ModUtils`	Mod Loader utilities (get mod, passage, etc.)
`jsPreloader`	`JsPreloader`	Script preloader
`modModLoadController`	`ModLoadController`	Mod load lifecycle controller
`modAddonPluginManager`	`AddonPluginManager`	Addon plugin manager
`modSC2JsEvalContext`	`SC2JsEvalContext`	Mod JS eval context

Main entry

Subpath import example

/// <reference types="@scml/sc2-modloader" />

Subpath Exports

Subpath	Description
`.`	Main entry, augments Window/global
`./AddonPlugin`	Addon plugin interfaces and manager
`./ModLoader`	ModLoader, ModInfo, ModBootJson, etc.
`./SC2DataManager`	SC2DataManager central data manager
`./ModLoadController`	Load controller, LogWrapper
`./ModZipReader`	ModZipReader, LocalLoader, RemoteLoader, etc.
`./ModOrderContainer`	ModOrderContainer, ModOrderItem, ModLoadFromSourceType
`./SC2DataInfoCache`	SC2DataInfo, PassageDataItem, CacheRecord, etc.
`./SugarCube2`	Passage types
`./Utils`	ModUtils utility class
`./ReplacePatcher`	Patch/replace utilities
`./ModPack/*`	ModPack, ModMeta, etc.
`./SemVer/InfiniteSemVer`	InfiniteSemVer version parsing
and more...	See package exports

API Reference

./AddonPlugin

AddonPluginHookPointEx interface

Interface for addon plugins; must implement registerMod(), optional lifecycle hooks.

AddonPluginManager class

registerAddonPlugin(), getAddonPlugin().

./SC2DataManager

SC2DataManager class

Mod and game data manager. Methods: getModUtils(), getModLoadController(), getSC2DataInfoCache(), getSC2DataInfoAfterPatch(), etc.

./ModLoader

ModInfo interface

Property	Type	Description
`name`	`string`	Mod name
`version`	`string`	Version
`alias`	`string[]`	Aliases
`cache`	`SC2DataInfo`	Cache data
`imgs`	`ModImg[]`	Image list
`scriptFileList_preload`	`[string, string][]`	Preload scripts

./Utils

ModUtils class

Methods: getModListName(), getMod(), getModZip(), getPassageData(), getAllPassageData(), createNewSC2DataInfoFromNow(), updatePassageData(), updatePassageDataMany(), etc.

Other subpaths

./ModZipReader, ./SC2DataInfoCache, ./SugarCube2, ./ReplacePatcher, ./ModOrderContainer, ./ModPack/*, ./SemVer/InfiniteSemVer.

Type Definition Source

Source Code

INFO

Upstream: https://github.com/Lyoko-Jeremie/sugarcube-2-ModLoader
Default branch: master
Build: pnpm run download && pnpm run build

#@scml/sc2-modloader

#Installation

#Quick Start

#Add type reference

#Use global objects

#Import types on demand

#Global Types global

#Subpath Exports

#API Reference

#./AddonPlugin

#AddonPluginHookPointEx interface

#AddonPluginManager class

#./SC2DataManager

#SC2DataManager class

#./ModLoader

#ModInfo interface

#./Utils

#ModUtils class

#Other subpaths

#Type Definition Source