diff --git a/README.md b/README.md index 109d1ed..051c667 100644 --- a/README.md +++ b/README.md @@ -28,145 +28,3 @@ version: 0.0.1 # Required files: # Optional - "**/*.yaml" ``` - -## Definable Playbill Resources - -- ability -- species -- entity -- item -- tag -- lore -- method -- rule - -### Shape: Ability - -```yaml -$define: ability # Required -id: ability-id # Required -name: Ability Name # Required -description: Some description # Required -type: action | cue | trait # Required -costs: # Optional, and each subfield is optional - ap: 1 - hp: 1 - xp: 1 - ep: 1 -roll: none (default), fate or a talent # Optional -boons: # Optional - - First boon - - Second boon -banes: # Optional - - First bane - - Second bane - -``` - -### Shape: Method - -```yaml -$define: method # Required -id: method-id # Required -name: Method Name # Required -description: Method Description # Required -curator: Method Curator Name # Required -abilities: - - [ability-id, another-ability] - - [yet-anotther, and-so-on] -``` - -### Shape: Species - -```yaml -$define: species # Required -id: species-id # Required -name: Species Name # Required -description: Species Description # Required -abilities: - - ability-id - - another-ability -bonuses: - bonusMaxHp: 1 - bonusMaxAp: 1 - bonusMaxEp: 1 - muscleProwess: adept - knowledgeProwess: adept - focusProwess: adept - charmProwess: adept - cunningProwess: adept - sparkProwess: adept -``` - -### Shape: Entity - -```yaml -$define: entity -id: entity-id # Required -name: Entity Name # Required -description: Entity Description # Required -species: species-id # Required -abilities: - - some-ability - - another-ability -stats: - hp: 1 - ap: 1 - ep: 1 - xp: 1 -talents: - muscle: adept - knowledge: adept - focus: adept - charm: adept - cunning: adept - spark: adept -damage: 0 -baggage: [] -``` - -### Shape: Item - -```yaml -$define: item -id: item-id # Required -name: Item Name # Required -description: Item Description # Required -type: wielded | worn | trinket -slots: 0 | 1 | 2 | 3 | 4 | 5 -tags: - - some-tag-id - - another-tag-id -``` - -### Shape: Item Tag - -```yaml -$define: tag -id: tag-id # Required -name: Tag Name # Required -description: Tag Description # Required -icon: https://some.url/icon.png -``` - -### Shape: Lore - -```yaml -$define: lore -id: lore-id # Required -name: Lore Entry Name # Required -description: Lore entry content # Required -categories: - - something - - another -``` - -### Shape: Rule - -```yaml -$define: rule -id: rule-id # Required -name: Rule Name # Required -description: Rule content # Required -overrule: existing-rule-id # Optional -``` diff --git a/bun.lock b/bun.lock index 73c6b29..d2e5706 100644 --- a/bun.lock +++ b/bun.lock @@ -4,7 +4,7 @@ "": { "name": "@proscenium/muse", "dependencies": { - "@proscenium/playbill": "0.0.1", + "@proscenium/playbill": "0.0.2", "chalk": "^5.4.1", "yaml": "^2.7.0", "zod": "^3.24.1", @@ -37,7 +37,7 @@ "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@1.9.4", "", { "os": "win32", "cpu": "x64" }, "sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA=="], - "@proscenium/playbill": ["@proscenium/playbill@0.0.1", "https://git.astral.camp/api/packages/proscenium/npm/%40proscenium%2Fplaybill/-/0.0.1/playbill-0.0.1.tgz", { "peerDependencies": { "typescript": "^5" } }, "sha512-uvv2Bt1+rjzuXl5y2t2C4KGgVda3orTZMVzb6gNAzStzKutiR3xJZkw2ULukYWWGyZ9BzzkRClSKVYka2Z3Png=="], + "@proscenium/playbill": ["@proscenium/playbill@0.0.2", "https://git.astral.camp/api/packages/proscenium/npm/%40proscenium%2Fplaybill/-/0.0.2/playbill-0.0.2.tgz", { "peerDependencies": { "typescript": "^5" } }, "sha512-zoYCHbm7DGmDRbB+tkQGPQTA5eR0xDHfyv+cp+3JfLy8n/6hOJvx+pG51emD1jBP+CecUE819nFriJqDf+ow0A=="], "@types/bun": ["@types/bun@1.2.3", "", { "dependencies": { "bun-types": "1.2.3" } }, "sha512-054h79ipETRfjtsCW9qJK8Ipof67Pw9bodFWmkfkaUaRiIQ1dIV2VTlheshlBx3mpKr0KeK8VqnMMCtgN9rQtw=="], diff --git a/package.json b/package.json index eb735b7..957d4b9 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "chalk": "^5.4.1", "yaml": "^2.7.0", "zod": "^3.24.1", - "@proscenium/playbill": "0.0.1" + "@proscenium/playbill": "0.0.2" }, "scripts": { "fmt": "bunx --bun biome check --fix",