@scml/sc2-verlnir 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -40
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,42 +1,3 @@
|
|
|
1
1
|
# @scml/sc2-verlnir
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
This package uses type declarations from `src/` directly in the repository. No `download` or `build` required.
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
pnpm add -D @scml/sc2-verlnir
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
### Main entry (global SugarCube types)
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
/// <reference types="@scml/sc2-verlnir" />
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
The main entry `./src/global.d.ts` declares SugarCube 2's global API.
|
|
22
|
-
|
|
23
|
-
## Types
|
|
24
|
-
|
|
25
|
-
### Global APIs (via `declare global`)
|
|
26
|
-
- **`Story`** – `StoryAPI` – Story and passage access.
|
|
27
|
-
- **`Config`** – `ConfigAPI` – Engine configuration.
|
|
28
|
-
- **`State`** – `StateAPI` – Game state, history, temporary variables.
|
|
29
|
-
- **`Passage`** – `PassageConstructor` – Current passage.
|
|
30
|
-
- **`Save`** – `SaveAPI` – Save/load.
|
|
31
|
-
- **`Dialog`** – `DialogAPI` – Dialog system.
|
|
32
|
-
- **`Engine`** – `EngineAPI` – Engine control.
|
|
33
|
-
- **`Macro`** – `MacroAPI` – Macro definitions.
|
|
34
|
-
- **`Scripting`** – `ScriptingAPI` – Script evaluation.
|
|
35
|
-
- **`Template`** – `TemplateAPI` – Template engine.
|
|
36
|
-
- **`UI`** / **`UIBar`** – `UIAPI` / `UIBarAPI` – UI components.
|
|
37
|
-
- **`Alert`**, **`Browser`**, **`Config`**, **`DebugBar`**, **`Fullscreen`**, **`Has`**, **`L10n`**, **`Links`**, **`LoadScreen`**, **`Setting`**, **`SimpleAudio`**, **`SimpleStore`**, **`Util`**, **`Visibility`**, **`Wikifier`** – Other SugarCube APIs.
|
|
38
|
-
- **`version`** – `VersionInfo`.
|
|
39
|
-
- **`session`**, **`storage`** – `SimpleStoreInstanceAPI | null`.
|
|
40
|
-
- **`settings`**, **`setup`** – `Record<string, unknown>`.
|
|
41
|
-
- **`idb`** – `IdbAPI`.
|
|
42
|
-
- **`window.SugarCube`** – Object containing all above APIs for detection and debugging.
|
|
3
|
+
See [documentation](https://scml-type.pages.dev/packages/sc2-verlnir).
|