@kawaijs/renderer-dom 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 +39 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @kawaijs/renderer-dom
|
|
2
|
+
|
|
3
|
+
**Semantic HTML5/CSS3 presentation renderer and design system for Kawaijs visual novels.**
|
|
4
|
+
|
|
5
|
+
Part of the [Kawaijs](https://github.com/biagio-scaglia/KawaiJS) visual novel engine.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @kawaijs/renderer-dom
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { compileScript } from '@kawaijs/parser';
|
|
17
|
+
import { mountKawaApp } from '@kawaijs/renderer-dom';
|
|
18
|
+
import '@kawaijs/renderer-dom/src/theme.css';
|
|
19
|
+
|
|
20
|
+
const story = compileScript(`
|
|
21
|
+
character yumia "Yumia"
|
|
22
|
+
|
|
23
|
+
label start:
|
|
24
|
+
scene bg classroom
|
|
25
|
+
show yumia happy
|
|
26
|
+
yumia "Hello from Kawaijs DOM renderer!"
|
|
27
|
+
`);
|
|
28
|
+
|
|
29
|
+
mountKawaApp(story, document.getElementById('app')!);
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Features
|
|
33
|
+
- **Semantic DOM Elements**: `.kawa-root`, `.kawa-stage`, `.kawa-dialogue-box`, `.kawa-choices`.
|
|
34
|
+
- **CSS Custom Properties**: Fully customizable theme tokens (`--kawa-primary-accent`, `--kawa-dialogue-bg`, etc.).
|
|
35
|
+
- **Typewriter Effect**: Smooth animated text with skip on click.
|
|
36
|
+
- **Built-in UI**: Quick menu (Back, History, Save, Load).
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
MIT © Biagio Scaglia
|