-
-
Notifications
You must be signed in to change notification settings - Fork 32
/
Copy pathschema-asset.json
1848 lines (1848 loc) · 71.6 KB
/
schema-asset.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"description": "An interface representing an *Ironsworn: Starforged* asset card.",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Name": {
"description": "The asset's name - the title printed on the card.",
"type": "string",
"title": "Name"
},
"Display": {
"$ref": "#/definitions/IDisplayWithTitle",
"description": "Data relevant to this item's display/rendering.",
"title": "Display"
},
"States": {
"description": "Describes any states that the asset might have, such as \"Broken\". Some states may disable the asset entirely.",
"type": "array",
"items": { "$ref": "#/definitions/IAssetState" },
"title": "States"
},
"Asset Type": {
"description": "The ID of the asset's parent AssetType",
"type": "string",
"title": "Asset Type"
},
"Usage": {
"$ref": "#/definitions/IAssetUsage",
"description": "Information on the asset's usage, such as whether its abilities are shared amongst the player characters.",
"title": "Usage"
},
"Attachments": {
"description": "Details on what attachments (other assets) are accepted by this asset.",
"$ref": "#/definitions/IAssetAttachment",
"title": "Attachments"
},
"Inputs": {
"description": "Data describing the Input controls that should be embedded in the card. Inputs embedded in specific asset abilities appear as keys of the corresponding ability object, instead.",
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/definitions/IInputSelect" },
{ "$ref": "#/definitions/IInputText" }
]
},
"title": "Inputs"
},
"Requirement": {
"description": "An optional markdown string representing the requirement text that appears at the top of some asset cards.",
"type": "string",
"title": "Requirement"
},
"Abilities": {
"description": "The asset's abilities.",
"type": "array",
"items": [
{ "$ref": "#/definitions/IAssetAbility" },
{ "$ref": "#/definitions/IAssetAbility" },
{ "$ref": "#/definitions/IAssetAbility" }
],
"minItems": 3,
"maxItems": 3,
"title": "Abilities"
},
"Condition Meter": {
"description": "Information on this asset's condition meter, if any.",
"$ref": "#/definitions/IConditionMeter",
"title": "Condition Meter"
},
"Tags": { "type": "array", "items": { "type": "string" }, "title": "Tags" },
"Source": {
"$ref": "#/definitions/ISource",
"description": "Information on this item's source.",
"title": "Source"
},
"Aliases": {
"description": "Alternate names for this item, including: names it had earlier in development that have since changed, alternate spellings/punctuation, common misspellings, and so on.",
"type": "array",
"items": { "type": "string" },
"title": "Aliases"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": [
"$id",
"Abilities",
"Asset Type",
"Display",
"Name",
"Source",
"Usage"
],
"definitions": {
"IDisplayWithTitle": {
"title": "IDisplayWithTitle",
"type": "object",
"properties": {
"Title": {
"description": "The title of this item as it appears printed in the rulebook. Intended for use as the item's header, label, etc.",
"type": "string",
"title": "Title"
},
"Icon": {
"description": "A URL pointing to a single SVG icon.",
"pattern": "^\\.\\./\\.\\./img/vector/[A-z-_0-9/]+\\.svg$",
"type": "string",
"title": "Icon"
},
"Images": {
"description": "An array of URLs pointing to one or more WEBP images.",
"pattern": "^\\.\\./\\.\\./img/raster/[A-z-_0-9/]+\\.webp$",
"type": "array",
"items": { "type": "string" },
"title": "Images"
},
"Color": {
"description": "A hex color associated with this item, for use as e.g. an accent color in its display.",
"pattern": "^#[A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9]$",
"type": "string",
"title": "Color"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Title"]
},
"IAssetState": {
"description": "Describes a possible state for an asset, like the \"Broken\" status for certain assets (mainly Modules in *Starforged*).\n\nStates are frequently toggled on and off by players; for real-world gameplay, this is generally represented by flipping the card over. A checkbox or other on/off toggle might serve the same function in a digital implementation.",
"title": "IAssetState",
"type": "object",
"properties": {
"Name": {
"description": "A string label name or label for the state.",
"type": "string",
"title": "Name"
},
"Enabled": {
"description": "Whether this state is currently enabled.",
"type": "boolean",
"title": "Enabled"
},
"Disables asset": {
"description": "Whether this state should disable the entire asset when `IAssetState.Enabled === true`",
"type": "boolean",
"title": "Disables asset"
},
"Impact": {
"description": "Whether this state counts as an Impact for the asset's owner.\n\nNote that for vehicles, this shouldn't be applied automatically unless your implementation has some way of telling which vehicle the PC is currently using.",
"type": "boolean",
"title": "Impact"
},
"Permanent": {
"description": "Whether or not this state is permanent.",
"type": "boolean",
"title": "Permanent"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Disables asset", "Enabled", "Impact", "Name", "Permanent"]
},
"IAssetUsage": {
"title": "IAssetUsage",
"type": "object",
"properties": {
"Shared": {
"description": "Whether the asset's abilities are shared with Allies.\n\nIf set to `true`, the asset's abilities can be invoked by **any** player character; if your app facilitates co-op or guided play, consider how you might expose these abilities to players other than the asset's owner.\n\nDefaults to `true` for Command Vehicle, Support Vehicle, and Module assets.",
"type": "boolean",
"title": "Shared"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Shared"]
},
"IAssetAttachment": {
"description": "Details which assets are valid attachments. The most prominent example in *Ironsworn: Starforged* is the STARSHIP asset (`Starship/Assets/Command_Vehicle/Starship`); Rover (`Starship/Assets/Support_Vehicle/Rover`) also has an elective ability that adds this property.",
"title": "IAssetAttachment",
"type": "object",
"properties": {
"Asset Types": {
"description": "The type of asset that this asset accepts as attachments.",
"type": "array",
"items": { "type": "string" },
"title": "Asset Types"
},
"Max": {
"description": "The maximum number of attached assets accepted by this asset. If undefined or null, there is no maximum.",
"type": ["null", "integer"],
"title": "Max"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Asset Types", "Max"]
},
"IInputSelect": {
"description": "An input where the user selects a single option from a list of pre-set options.\nSuggested rendering: a drop-down selection menu.",
"title": "IInputSelect",
"type": "object",
"properties": {
"Input Type": {
"$ref": "#/definitions/InputType.Select",
"title": "Input Type"
},
"Sets": {
"description": "Hints which attribute(s) set by this dropdown's options.",
"type": "array",
"items": { "$ref": "#/definitions/IInputSelectAttributeDefinition" },
"title": "Sets"
},
"Options": {
"type": "array",
"items": { "$ref": "#/definitions/IInputSelectOption" },
"title": "Options"
},
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+(/Abilities/[1-3])?/Inputs/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Adjustable": {
"description": "Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically `false`, while something like a clock or tally would be `true`.\n\nIt's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality \"front and center\" or as a secondary interaction (via long press, right click, etc);",
"type": "boolean",
"title": "Adjustable"
},
"Name": {
"description": "The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.\n\nIf the item has Display.Title, that should be preferred for most user-facing labels.",
"type": "string",
"title": "Name"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Adjustable", "Input Type", "Name", "Options", "Sets"]
},
"InputType.Select": {
"title": "InputType.Select",
"type": "string",
"enum": ["Select"]
},
"IInputSelectAttributeDefinition": {
"description": "Provides hints for the keys and typing of an{@linkIInputSelect}'s child{@linkIInputSelectOption}s.",
"title": "IInputSelectAttributeDefinition",
"type": "object",
"properties": {
"Key": { "type": "string", "title": "Key" },
"Type": {
"$ref": "#/definitions/InputSelectOptionType",
"title": "Type"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Key", "Type"]
},
"InputSelectOptionType": {
"description": "The type of an attribute set by a Select Input.",
"title": "InputSelectOptionType",
"enum": ["Condition Meter", "Number", "Stat", "String"],
"type": "string"
},
"IInputSelectOption": {
"description": "Represents an option in an{@linkIInputSelect}.",
"title": "IInputSelectOption",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Inputs/[A-z_-]+/Options/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Set": {
"description": "A array describing what attribute keys should be set to when this option is active. *All* items in the array should be set in this manner.",
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/definitions/IInputSelectOptionSetterMeter" },
{ "$ref": "#/definitions/IInputSelectOptionSetterNumber" },
{ "$ref": "#/definitions/IInputSelectOptionSetterStat" },
{ "$ref": "#/definitions/IInputSelectOptionSetterString" }
]
},
"title": "Set"
},
"Name": {
"description": "The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.\n\nIf the item has Display.Title, that should be preferred for most user-facing labels.",
"type": "string",
"title": "Name"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Name", "Set"]
},
"IInputSelectOptionSetterMeter": {
"description": "A condition meter set by an{@linkIInputSelectOption}.",
"title": "IInputSelectOptionSetterMeter",
"type": "object",
"properties": {
"Type": {
"$ref": "#/definitions/InputSelectOptionType.ConditionMeter",
"title": "Type"
},
"Value": {
"$ref": "#/definitions/PlayerConditionMeter",
"title": "Value"
},
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Inputs/[A-z_-]+/Options/[A-z_-]+/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Key": { "type": "string", "title": "Key" }
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Key", "Type", "Value"]
},
"InputSelectOptionType.ConditionMeter": {
"description": "A reference to one of the player character's condition meters: Health, Spirit, or Supply.",
"title": "InputSelectOptionType.ConditionMeter",
"type": "string",
"enum": ["Condition Meter"]
},
"PlayerConditionMeter": {
"description": "Standard player character condition meters.",
"title": "PlayerConditionMeter",
"enum": ["Health", "Spirit", "Supply"],
"type": "string"
},
"IInputSelectOptionSetterNumber": {
"description": "An integer value set by an{@linkIInputSelectOption}.",
"title": "IInputSelectOptionSetterNumber",
"type": "object",
"properties": {
"Type": {
"$ref": "#/definitions/InputSelectOptionType.Number",
"title": "Type"
},
"Value": { "type": "integer", "title": "Value" },
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Inputs/[A-z_-]+/Options/[A-z_-]+/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Key": { "type": "string", "title": "Key" }
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Key", "Type", "Value"]
},
"InputSelectOptionType.Number": {
"description": "A arbitrary pre-set number value.",
"title": "InputSelectOptionType.Number",
"type": "string",
"enum": ["Number"]
},
"IInputSelectOptionSetterStat": {
"description": "A stat set by an{@linkIInputSelectOption}.",
"title": "IInputSelectOptionSetterStat",
"type": "object",
"properties": {
"Type": {
"$ref": "#/definitions/InputSelectOptionType.Stat",
"title": "Type"
},
"Value": { "$ref": "#/definitions/Stat", "title": "Value" },
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Inputs/[A-z_-]+/Options/[A-z_-]+/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Key": { "type": "string", "title": "Key" }
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Key", "Type", "Value"]
},
"InputSelectOptionType.Stat": {
"description": "A reference to one of the player character's stats: Edge, Heart, Iron, Shadow, or Wits.",
"title": "InputSelectOptionType.Stat",
"type": "string",
"enum": ["Stat"]
},
"Stat": {
"description": "Enumerates player character stats.",
"title": "Stat",
"enum": ["Edge", "Heart", "Iron", "Shadow", "Wits"],
"type": "string"
},
"IInputSelectOptionSetterString": {
"description": "An arbitrary string value set by an{@linkIInputSelectOption}.",
"title": "IInputSelectOptionSetterString",
"type": "object",
"properties": {
"Type": {
"$ref": "#/definitions/InputSelectOptionType.String",
"title": "Type"
},
"Value": { "type": "string", "title": "Value" },
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Inputs/[A-z_-]+/Options/[A-z_-]+/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Key": { "type": "string", "title": "Key" }
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Key", "Type", "Value"]
},
"InputSelectOptionType.String": {
"description": "An arbitrary pre-set string value.",
"title": "InputSelectOptionType.String",
"type": "string",
"enum": ["String"]
},
"IInputText": {
"description": "A text input.\nSuggested rendering: a single-line text input, similar to `<input type='text'>` in HTML.",
"title": "IInputText",
"type": "object",
"properties": {
"Input Type": {
"$ref": "#/definitions/InputType.Text",
"title": "Input Type"
},
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+(/Abilities/[1-3])?/Inputs/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Adjustable": {
"description": "Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically `false`, while something like a clock or tally would be `true`.\n\nIt's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality \"front and center\" or as a secondary interaction (via long press, right click, etc);",
"type": "boolean",
"title": "Adjustable"
},
"Name": {
"description": "The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.\n\nIf the item has Display.Title, that should be preferred for most user-facing labels.",
"type": "string",
"title": "Name"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Adjustable", "Input Type", "Name"]
},
"InputType.Text": {
"title": "InputType.Text",
"type": "string",
"enum": ["Text"]
},
"IAssetAbility": {
"description": "Represents one of an asset's three abilities.",
"title": "IAssetAbility",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]$",
"type": "string",
"title": "$id"
},
"Name": {
"description": "Ironsworn companion assets provide names for their abilities. Starforged asset abilities do not have names.",
"type": "string",
"title": "Name"
},
"Moves": {
"description": "New moves added by this asset ability.",
"type": "array",
"items": { "$ref": "#/definitions/IMove" },
"title": "Moves"
},
"Inputs": {
"description": "User inputs (text, clocks, etc) associated with this asset ability.",
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/definitions/IInputClock" },
{ "$ref": "#/definitions/IInputNumber" },
{ "$ref": "#/definitions/IInputText" }
]
},
"title": "Inputs"
},
"Alter Moves": {
"description": "Information on how this ability alters moves when enabled.",
"type": "array",
"items": { "$ref": "#/definitions/IAlterMove" },
"title": "Alter Moves"
},
"Alter Properties": {
"description": "Information on how this ability alters its parent asset when enabled.",
"$ref": "#/definitions/IAssetAlterProperties",
"title": "Alter Properties"
},
"Alter Momentum": {
"description": "Information on how this ability alters its owner's momentum (triggers an effect on burn, on reset, etc)",
"$ref": "#/definitions/IAlterMomentum",
"title": "Alter Momentum"
},
"Enabled": {
"description": "Whether the asset ability is enabled or not. In most cases, the first asset ability defaults to 'true' and the others to 'false'. If none of an asset's abilities are set to 'true', the player can pick which the ability they start with when purchasing the asset.",
"type": "boolean",
"title": "Enabled"
},
"Text": {
"description": "The item's rules text as a markdown string.",
"type": "string",
"title": "Text"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Enabled", "Text"]
},
"IMove": {
"description": "Interface representing a Starforged move.",
"title": "IMove",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3])/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Name": {
"description": "The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.\n\nIf the item has Display.Title, that should be preferred for most user-facing labels.",
"type": "string",
"title": "Name"
},
"Asset": {
"description": "The ID of the parent Asset of the move, if any.",
"type": "string",
"title": "Asset"
},
"Category": {
"description": "The ID of the move's category.",
"type": "string",
"title": "Category"
},
"Progress Move": {
"description": "Whether or not the move is a Progress Move. Progress moves roll two challenge dice against a progress score.",
"type": "boolean",
"title": "Progress Move"
},
"Variant of": {
"description": "The ID of the move that this move is a variant of, if any.",
"type": "string",
"title": "Variant of"
},
"Trigger": {
"$ref": "#/definitions/IMoveTrigger",
"description": "The move's trigger data.",
"title": "Trigger"
},
"Oracles": {
"description": "The IDs of any oracles directly referenced by the move, or vice versa.",
"type": "array",
"items": { "type": "string" },
"title": "Oracles"
},
"Outcomes": {
"description": "Outcome information for the move.",
"$ref": "#/definitions/IMoveOutcomes",
"title": "Outcomes"
},
"Display": {
"$ref": "#/definitions/IDisplayWithTitle",
"description": "Data relevant to this item's display/rendering.",
"title": "Display"
},
"Tags": {
"type": "array",
"items": { "type": "string" },
"title": "Tags"
},
"Text": {
"description": "The item's rules text as a markdown string.",
"type": "string",
"title": "Text"
},
"Source": {
"$ref": "#/definitions/ISource",
"description": "Information on this item's source.",
"title": "Source"
},
"Optional": {
"description": "Whether or not the source material presents this rules item as optional.",
"default": false,
"type": "boolean",
"title": "Optional"
},
"Suggestions": {
"$ref": "#/definitions/ISuggestions",
"description": "\"Non-canonical\" suggestions of related items. They might be convenient to present to the user, but in most implementations rolling them automatically is not recommended.",
"title": "Suggestions"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": [
"$id",
"Category",
"Display",
"Name",
"Optional",
"Source",
"Text",
"Trigger"
]
},
"IMoveTrigger": {
"description": "Describes the trigger conditions of the move.",
"title": "IMoveTrigger",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Trigger$",
"type": "string",
"title": "$id"
},
"Text": {
"description": "A markdown string containing the primary trigger text for this move.\n\nSecondary triggers (for specific stats or uses of an asset ability) are described in `Options`.",
"type": "string",
"title": "Text"
},
"By": {
"description": "Information on who can trigger this item. Used mainly by asset abilities, some of which can trigger from an Ally's move.\n\nIf unspecified, assume `Ally` is `false` and `Player` is `true`.",
"$ref": "#/definitions/IMoveTriggerBy",
"title": "By"
},
"Options": {
"description": "Information on any action rolls or progress rolls that are made when this move is triggered (which may describe a specific subset of the primary trigger in their own `Text` property).\n\nIf there's no action rolls or progress rolls attached to this move, this is `undefined`.",
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/definitions/IMoveTriggerOptionAction" },
{ "$ref": "#/definitions/IMoveTriggerOptionProgress" }
]
},
"title": "Options"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id"]
},
"IMoveTriggerBy": {
"title": "IMoveTriggerBy",
"type": "object",
"properties": {
"Player": {
"description": "Whether the player character who owns this item can trigger it. Unsurprisingly, this is usually true, but there's a few exceptions: see *Starforged's* LOYALIST asset for an example.",
"type": "boolean",
"title": "Player"
},
"Ally": {
"description": "Whether an Ally (a player character other than the owner) can trigger this item. This is usually false, but there's several exceptions among asset abilities.",
"type": "boolean",
"title": "Ally"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Ally", "Player"]
},
"IMoveTriggerOptionAction": {
"title": "IMoveTriggerOptionAction",
"type": "object",
"properties": {
"Roll type": {
"$ref": "#/definitions/RollType.Action",
"description": "Whether this option is an action roll or progress roll.",
"title": "Roll type"
},
"Using": {
"description": "The stat(s) or progress track(s) that may be rolled with this move trigger option.",
"type": "array",
"items": { "type": "string" },
"title": "Using"
},
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Trigger/Options/[0-9]+$",
"type": "string",
"title": "$id"
},
"Method": {
"$ref": "#/definitions/RollMethod",
"description": "The method used to choose the stat or track in the `Using` array.",
"title": "Method"
},
"Custom stat": {
"description": "Defines a custom stat, if one is included in this object's `With` array.",
"$ref": "#/definitions/ICustomStat",
"title": "Custom stat"
},
"Text": {
"description": "The item's rules text as a markdown string.",
"type": "string",
"title": "Text"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Method", "Roll type", "Using"]
},
"RollType.Action": {
"title": "RollType.Action",
"type": "string",
"enum": ["Action roll"]
},
"RollMethod": {
"description": "The stat(s) or progress track(s) that may be rolled with the parent move trigger option.",
"title": "RollMethod",
"enum": [
"All",
"Any",
"Highest",
"Inherit",
"Lowest",
"Strong Hit",
"Weak Hit"
],
"type": "string"
},
"ICustomStat": {
"title": "ICustomStat",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat$",
"type": "string",
"title": "$id"
},
"Options": {
"type": "array",
"items": { "$ref": "#/definitions/ICustomStatOption" },
"title": "Options"
},
"Name": {
"description": "The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.\n\nIf the item has Display.Title, that should be preferred for most user-facing labels.",
"type": "string",
"title": "Name"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Name", "Options"]
},
"ICustomStatOption": {
"title": "ICustomStatOption",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat/[A-z_-]+$",
"type": "string",
"title": "$id"
},
"Name": {
"description": "The name/label for this specific value of the custom stat.",
"type": "string",
"title": "Name"
},
"Value": {
"description": "The numeric value to be used as +stat when making an Action Roll.",
"type": "integer",
"title": "Value"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Name", "Value"]
},
"IMoveTriggerOptionProgress": {
"title": "IMoveTriggerOptionProgress",
"type": "object",
"properties": {
"Roll type": {
"$ref": "#/definitions/RollType.Progress",
"description": "Whether this option is an action roll or progress roll.",
"title": "Roll type"
},
"Using": {
"description": "The stat(s) or progress track(s) that may be rolled with this move trigger option.",
"type": "array",
"items": {
"enum": [
"Bonds",
"Bonds Legacy",
"Combat",
"Connection",
"Delve",
"Discoveries Legacy",
"Expedition",
"Journey",
"Quests Legacy",
"Scene Challenge",
"Vow"
],
"type": "string"
},
"title": "Using"
},
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Trigger/Options/[0-9]+$",
"type": "string",
"title": "$id"
},
"Method": {
"$ref": "#/definitions/RollMethod",
"description": "The method used to choose the stat or track in the `Using` array.",
"title": "Method"
},
"Custom stat": {
"description": "Defines a custom stat, if one is included in this object's `With` array.",
"$ref": "#/definitions/ICustomStat",
"title": "Custom stat"
},
"Text": {
"description": "The item's rules text as a markdown string.",
"type": "string",
"title": "Text"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Method", "Roll type", "Using"]
},
"RollType.Progress": {
"title": "RollType.Progress",
"type": "string",
"enum": ["Progress roll"]
},
"IMoveOutcomes": {
"title": "IMoveOutcomes",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Outcomes$",
"type": "string",
"title": "$id"
},
"Strong Hit": {
"$ref": "#/definitions/IOutcomeInfo",
"title": "Strong Hit"
},
"Weak Hit": {
"$ref": "#/definitions/IOutcomeInfo",
"title": "Weak Hit"
},
"Miss": { "$ref": "#/definitions/IOutcomeInfo", "title": "Miss" }
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Miss", "Strong Hit", "Weak Hit"]
},
"IOutcomeInfo": {
"title": "IOutcomeInfo",
"type": "object",
"properties": {
"$id": {
"description": "The item's unique string ID.",
"pattern": "^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Outcomes/((Miss|Strong_Hit)(/With_a_Match)?|Weak_Hit)$",
"type": "string",
"title": "$id"
},
"With a Match": {
"description": "Defines a different outcome for this result with a match. Its text should replace the text of this object.",
"$ref": "#/definitions/IOutcomeInfo",
"title": "With a Match"
},
"Count as": {
"description": "Count this roll as another roll outcome, e.g. \"Count a weak hit as a miss\"",
"enum": ["Miss", "Strong Hit", "Weak Hit"],
"type": "string",
"title": "Count as"
},
"Reroll": {
"description": "Information on rerolls offered by this move.",
"$ref": "#/definitions/IMoveReroll",
"title": "Reroll"
},
"In Control": {
"description": "Whether this outcome leaves the player character in control or not. If unspecified, assume that it's `true` on a Strong Hit, and `false` on a Weak Hit or Miss.",
"type": "boolean",
"title": "In Control"
},
"Text": {
"description": "The item's rules text as a markdown string.",
"type": "string",
"title": "Text"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["$id", "Text"]
},
"IMoveReroll": {
"description": "Describes a reroll offered by a move outcome. The vast majority of rerolls in *Ironsworn* are elective, so automatic rerolling isn't recommended.",
"title": "IMoveReroll",
"type": "object",
"properties": {
"Text": {
"description": "The markdown string describing the conditions of the reroll. It should be presented to the user so that they can decide whether a reroll is appropriate.",
"type": "string",
"title": "Text"
},
"Dice": {
"$ref": "#/definitions/RerollType",
"description": "The dice to be rerolled.",
"title": "Dice"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Dice", "Text"]
},
"RerollType": {
"description": "Enumerates which dice are to be rerolled.",
"title": "RerollType",
"enum": ["Action die", "All", "Any", "Challenge dice", "Challenge die"],
"type": "string"
},
"ISource": {
"description": "Interface representing data on this item's source. For 'canonical' content, this is usually a book with numbered pages, but it might also be a link to a web site.",
"title": "ISource",
"type": "object",
"properties": {
"Title": {
"description": "The title of the source.\n\nFor 'canonical' content, use one of the enumerated `SourceTitle` strings.\n\nFor 3rd-party content (including homebrew) that's been released as part of a titled document, use the title of that document (e.g. \"Steelforged\", \"Ironsmith\").\n\nIf the source has no particular title (for instance, it's a single custom element in a VTT implementation), use \"Custom\".",
"type": "string",
"title": "Title"
},
"Authors": {
"description": "The author(s) of this item. For 'canonical' content, this one's usually pretty obvious 😉 However, it's included so that homebrew content can use the same interface/schema.",
"default": ["Shawn Tomkin"],
"type": "array",
"items": { "type": "string" },
"title": "Authors"
},
"Date": {
"description": "The 6-number date string formatted as `MMDDYY`. Relevant only during Starforged development; it will be deprecated once the game is released.",
"pattern": "^(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])([0-9][0-9])$",
"type": "string",
"title": "Date"
},
"Page": {
"description": "The page on which the item appears most prominently in the source material (if it's in a format that uses page numbers).",
"type": "integer",
"title": "Page"
},
"Url": {
"description": "The URL where the source material is available.",
"pattern": "^https?://.*$",
"type": "string",
"title": "Url"
}
},
"defaultProperties": [],
"additionalProperties": false,
"required": ["Authors", "Title"]
},
"ISuggestions": {
"description": "Describes \"non-canonical\" suggestions for game content related to the parent item.\n\nThese are intended be offered as convenient shortcuts for the user (for instance, including a menu dropdown for rolling on suggested tables); having them roll automatically is **not recommended** for most projects.\n\nThese can be safely ignored if that functionality is not desired.",
"title": "ISuggestions",
"$ref": "#/definitions/ISuggestions_1"
},
"ISuggestions_1": {
"description": "Describes \"non-canonical\" suggestions for game content related to the parent item.\n\nThese are intended be offered as convenient shortcuts for the user (for instance, including a menu dropdown for rolling on suggested tables); having them roll automatically is **not recommended** for most projects.\n\nThese can be safely ignored if that functionality is not desired.",
"title": "ISuggestions_1",
"type": "object",
"properties": {
"Game objects": {
"description": "Suggested game objects and their parameters.",
"type": "array",
"items": { "$ref": "#/definitions/IGameObject" },
"title": "Game objects"
},