@toonstrip/pack-example 0.1.0 → 0.1.1
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 +51 -0
- package/package.json +16 -2
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @toonstrip/pack-example
|
|
2
|
+
|
|
3
|
+
A second, small, wholly original toonstrip asset pack: one character
|
|
4
|
+
("Pip", simple procedurally-drawn shapes — not AI-generated) with a
|
|
5
|
+
NEUTRAL/HAPPY face pair and NEUTRAL/WAVE/SHRUG torsos, plus one original
|
|
6
|
+
backdrop ("meadow"). Exists to prove the toonstrip pack contract isn't
|
|
7
|
+
secretly coupled to `@toonstrip/pack-comic-chat`'s decoded-Comic-Chat
|
|
8
|
+
origin, and to serve as a minimal starting point for building your own pack.
|
|
9
|
+
Zero runtime dependencies.
|
|
10
|
+
|
|
11
|
+
Part of [toonstrip](https://github.com/dkdev24/toonstrip), a
|
|
12
|
+
framework-embeddable comic-strip renderer.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
npm install @toonstrip/pack-example
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
**Node (`@toonstrip/core`):**
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { loadCastManifest } from "@toonstrip/pack-example";
|
|
26
|
+
|
|
27
|
+
const manifest = loadCastManifest(); // CastManifest, sheet/backdrop paths are absolute
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**Browser (`@toonstrip/element`) / Astro (`@toonstrip/astro`):** don't
|
|
31
|
+
import this package's JS directly — pass it by name to the integration/element
|
|
32
|
+
instead, so its `pack.json` + `characters/` + `backdrops/` files get served
|
|
33
|
+
over HTTP.
|
|
34
|
+
|
|
35
|
+
## Validate
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
npx @toonstrip/cli pack validate node_modules/@toonstrip/pack-example
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Building your own pack
|
|
42
|
+
|
|
43
|
+
This package's `scripts/generate.mjs` is a worked, self-contained example of
|
|
44
|
+
building a pack's art and manifests from scratch. See
|
|
45
|
+
[`docs/packs.md`](https://github.com/dkdev24/toonstrip/blob/main/docs/packs.md)
|
|
46
|
+
in the repo for the full contract and a step-by-step "add a character"
|
|
47
|
+
walkthrough.
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@toonstrip/pack-example",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "A small, original toonstrip asset pack proving the pack contract, and a starting point for building your own.",
|
|
4
5
|
"license": "MIT",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"main": "./dist/index.js",
|
|
@@ -26,5 +27,18 @@
|
|
|
26
27
|
},
|
|
27
28
|
"publishConfig": {
|
|
28
29
|
"access": "public"
|
|
29
|
-
}
|
|
30
|
+
},
|
|
31
|
+
"keywords": [
|
|
32
|
+
"toonstrip",
|
|
33
|
+
"comic",
|
|
34
|
+
"asset-pack",
|
|
35
|
+
"example"
|
|
36
|
+
],
|
|
37
|
+
"repository": {
|
|
38
|
+
"type": "git",
|
|
39
|
+
"url": "git+https://github.com/dkdev24/toonstrip.git",
|
|
40
|
+
"directory": "packages/pack-example"
|
|
41
|
+
},
|
|
42
|
+
"homepage": "https://github.com/dkdev24/toonstrip#readme",
|
|
43
|
+
"bugs": "https://github.com/dkdev24/toonstrip/issues"
|
|
30
44
|
}
|