@lippelt/srd-core 0.1.1 → 0.1.2
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 +11 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @lippelt/srd-core
|
|
2
2
|
|
|
3
|
-
Contrato +
|
|
3
|
+
Contrato + registro para sistemas de RPG plugáveis. Cada sistema (D&D 5e, Pathfinder, Lancer etc) é distribuído como seu próprio pacote (`@lippelt/srd-*`), implementando o contrato `System` definido aqui.
|
|
4
4
|
|
|
5
|
-
Pensado
|
|
5
|
+
Pensado para ser consumido por painéis de mesa, ferramentas de jogo e VTTs leves — **agnóstico de UI**.
|
|
6
6
|
|
|
7
7
|
## Instalação
|
|
8
8
|
|
|
@@ -26,9 +26,9 @@ const result = sys?.rules?.roll?.('attack', { modifier: 5, targetAC: 18, advanta
|
|
|
26
26
|
## API
|
|
27
27
|
|
|
28
28
|
- `register(system: System): void` — registra um sistema. Idempotente (mesma referência); colisão de id com instância diferente lança erro.
|
|
29
|
-
- `getSystem(id: SystemId): System | null` — resolve
|
|
29
|
+
- `getSystem(id: SystemId): System | null` — resolve síncrono; retorna `null` se não registrado.
|
|
30
30
|
- `listRegisteredSystems(): SystemId[]` — todos os ids atualmente registrados.
|
|
31
|
-
- `clearRegistry(): void` — limpa o
|
|
31
|
+
- `clearRegistry(): void` — limpa o registro (útil em testes).
|
|
32
32
|
|
|
33
33
|
## Contrato `System`
|
|
34
34
|
|
|
@@ -41,13 +41,15 @@ interface System {
|
|
|
41
41
|
dicePresets: DicePreset[]
|
|
42
42
|
conditions: ConditionDef[]
|
|
43
43
|
trackerFields: TrackerField[]
|
|
44
|
-
rules?: SystemRules // opcional —
|
|
44
|
+
rules?: SystemRules // opcional — rolagens customizadas (vantagem, crítico, dano)
|
|
45
45
|
}
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
+
> Os nomes dos campos no contrato permanecem em inglês por serem identificadores de código (consumidos por TypeScript em qualquer idioma de projeto).
|
|
49
|
+
|
|
48
50
|
### `DicePreset`
|
|
49
51
|
|
|
50
|
-
Botões
|
|
52
|
+
Botões de rolagem rápida por categoria (`check`, `attack`, `damage`, `save`, `special`):
|
|
51
53
|
|
|
52
54
|
```ts
|
|
53
55
|
{ id: 'd20-adv', label: 'd20 com vantagem', notation: '2d20kh1', category: 'check' }
|
|
@@ -55,10 +57,10 @@ Botões rápidos de rolagem por categoria (`check`, `attack`, `damage`, `save`,
|
|
|
55
57
|
|
|
56
58
|
### `ConditionDef`
|
|
57
59
|
|
|
58
|
-
|
|
60
|
+
Condições/estados do sistema:
|
|
59
61
|
|
|
60
62
|
```ts
|
|
61
|
-
{ id: 'poisoned', label: 'Envenenado', summary: 'Desvantagem em ataques e testes de
|
|
63
|
+
{ id: 'poisoned', label: 'Envenenado', summary: 'Desvantagem em ataques e testes de habilidade.' }
|
|
62
64
|
```
|
|
63
65
|
|
|
64
66
|
### `TrackerField`
|
|
@@ -72,7 +74,7 @@ Campos numéricos/booleanos extras por combatente:
|
|
|
72
74
|
|
|
73
75
|
### `SystemRules` (opcional)
|
|
74
76
|
|
|
75
|
-
Funções puras de
|
|
77
|
+
Funções puras de rolagem/dano que vão além da notação `NdM±K`:
|
|
76
78
|
|
|
77
79
|
```ts
|
|
78
80
|
rules?: {
|
package/package.json
CHANGED