@hexah/create-skin 0.1.4 → 0.1.5
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 +4 -0
- package/package.json +1 -1
- package/template/README.md +17 -0
package/README.md
CHANGED
|
@@ -4,6 +4,10 @@ Scaffolder skórki Hexah — generuje projekt **zdalnej skórki Module Federatio
|
|
|
4
4
|
`@hexah/skin-sdk`) z gotowym workflowem dev (HMR) i podłączeniem do hosta na środowisku
|
|
5
5
|
testowym.
|
|
6
6
|
|
|
7
|
+
Kontrakt skórki (hooki danych, UI, sloty) dostarcza paczka
|
|
8
|
+
**[`@hexah/skin-sdk`](https://www.npmjs.com/package/@hexah/skin-sdk)** — wygenerowany projekt
|
|
9
|
+
ma ją już w zależnościach (`npm install @hexah/skin-sdk`, by dodać do istniejącego).
|
|
10
|
+
|
|
7
11
|
## Użycie
|
|
8
12
|
|
|
9
13
|
```bash
|
package/package.json
CHANGED
package/template/README.md
CHANGED
|
@@ -55,3 +55,20 @@ odświeżeniu (i ponownym pobraniu remote'a).
|
|
|
55
55
|
— nie pakujesz ich, dostajesz instancje z aplikacji-hosta.
|
|
56
56
|
- `apiVersion` musi być zgodna z hostem (ten sam major, minor ≤ host) — inaczej host odmówi
|
|
57
57
|
załadowania.
|
|
58
|
+
|
|
59
|
+
## SDK (`@hexah/skin-sdk`)
|
|
60
|
+
|
|
61
|
+
Cały kontrakt skórki (stałe, typy, hooki danych, prymitywy UI, sloty) pochodzi z paczki
|
|
62
|
+
`@hexah/skin-sdk` — jest już w `dependencies` tego projektu. W istniejącym projekcie dodasz ją:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npm install @hexah/skin-sdk
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
- Paczka na npm (pełna lista hooków i kontrakt): <https://www.npmjs.com/package/@hexah/skin-sdk>
|
|
69
|
+
- Hooki danych per strona gry (`useArticles`, `useTales`, `useTown`, `useGuild`, `useVillages`,
|
|
70
|
+
`useReports`, `useSettings`, `useShop`, `useAccountProfile`, `useGptThreads`), stan
|
|
71
|
+
(`useShard`/`useCharacter`/…), usługi (`useSnackbar`/`useDialog`), sloty (`useSlots`) i
|
|
72
|
+
prymitywy UI — opis w README paczki.
|
|
73
|
+
|
|
74
|
+
Importuj **wyłącznie** z `@hexah/skin-sdk`. Zadeklarowane `apiVersion` musi być zgodne z hostem.
|