games.atmosphere.define
Schema Diff
+1 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"id": "games.atmosphere.define",
3
3
"defs": {
4
4
"all": {
5
5
"type": "object",
6
6
"required": [
7
7
"check",
8
8
"rules"
9
9
],
10
10
"properties": {
11
11
"check": {
12
12
"type": "string",
13
13
"const": "all"
14
14
},
15
15
"label": {
16
16
"type": "string",
17
17
"maxLength": 120
18
18
},
19
19
"rules": {
20
20
"type": "array",
21
21
"items": {
22
22
"ref": "#rule",
23
23
"type": "ref"
24
24
},
25
25
"maxLength": 16,
26
26
"minLength": 1
27
27
},
28
28
"acquire": {
29
29
"type": "string",
30
30
"format": "uri"
31
31
}
32
32
},
33
33
"description": "Logical AND. Passes only when every sub-rule passes."
34
34
},
35
35
"any": {
36
36
"type": "object",
37
37
"required": [
38
38
"check",
39
39
"rules"
40
40
],
41
41
"properties": {
42
42
"check": {
43
43
"type": "string",
44
44
"const": "any"
45
45
},
46
46
"label": {
47
47
"type": "string",
48
48
"maxLength": 120
49
49
},
50
50
"rules": {
51
51
"type": "array",
52
52
"items": {
53
53
"ref": "#rule",
54
54
"type": "ref"
55
55
},
56
56
"maxLength": 16,
57
57
"minLength": 1
58
58
},
59
59
"acquire": {
60
60
"type": "string",
61
61
"format": "uri"
62
62
}
63
63
},
64
64
"description": "Logical OR. Passes when at least one sub-rule passes, e.g. 'holds a sheet in any of these systems'."
65
65
},
66
66
"not": {
67
67
"type": "object",
68
68
"required": [
69
69
"check",
70
70
"rule"
71
71
],
72
72
"properties": {
73
73
"rule": {
74
74
"ref": "#rule",
75
75
"type": "ref"
76
76
},
77
77
"check": {
78
78
"type": "string",
79
79
"const": "not"
80
80
},
81
81
"label": {
82
82
"type": "string",
83
83
"maxLength": 120
84
84
}
85
85
},
86
86
"description": "Logical NOT. Passes only when the sub-rule fails. Use for exclusion gates: 'has not already claimed this reward'."
87
87
},
88
88
"main": {
89
89
"key": "any",
90
90
"type": "record",
91
91
"record": {
92
92
"type": "object",
93
93
"required": [
94
94
"name",
95
95
"url",
96
96
"publisher",
97
97
"category",
98
98
"createdAt"
99
99
],
100
100
"properties": {
101
101
"url": {
102
102
"type": "string",
103
103
"format": "uri",
104
104
"description": "URL at which the game is played, downloaded, or accessed. This is a launch location, not the record's identity."
105
105
},
106
106
"icon": {
107
107
"type": "blob",
108
108
"accept": [
109
109
"image/png",
110
110
"image/webp"
111
111
],
112
112
"maxSize": 512000,
113
113
"description": "Square icon for compact display contexts. Recommended 256x256 px."
114
114
},
115
115
"name": {
116
116
"type": "string",
117
117
"maxLength": 100,
118
118
"description": "Display name of the experience as shown in portal listings."
119
119
},
120
120
"tags": {
121
121
"type": "array",
122
122
"items": {
123
123
"type": "string",
124
124
"maxLength": 32
125
125
},
126
126
"maxLength": 12,
127
127
"description": "Freeform tags for search and discovery (e.g. 'arcade', 'pixel art', 'multiplayer')."
128
128
},
129
129
"uses": {
130
130
"type": "array",
131
131
"items": {
132
132
"ref": "#recordUse",
133
133
"type": "ref"
134
134
},
135
135
"maxLength": 32,
136
136
"description": "Non-required records this game uses, understands, produces, validates, or wants portals to read. Use requires[] only for hard gates. Use uses[] for everything else: optional gameplay perks, character imports, cosmetics, bonuses, interoperability, stats, saves, activity, sessions, replays, leaderboards, labels, grants, validation, inventory, or profile context. The role and purpose fields explain whether the use is a player-facing benefit, a game-authored record, or a portal-readable display surface."
137
137
},
138
138
"cover": {
139
139
"type": "blob",
140
140
"accept": [
141
141
"image/png",
142
142
"image/jpeg",
143
143
"image/webp"
144
144
],
145
145
"maxSize": 4000000,
146
146
"description": "Primary cover image. Portals display this as the card thumbnail. Recommended ratio 16:9."
147
147
},
148
148
"media": {
149
149
"type": "array",
150
150
"items": {
151
151
"ref": "#mediaItem",
152
152
"type": "ref"
153
153
},
154
154
"maxLength": 24,
155
155
"description": "Extended media gallery, screenshots, banners, key art, and posters a portal can show on a detail page. 'cover' and 'icon' above stay the primary card images; this is the deeper set, mirroring the rich galleries dedicated game catalogs keep."
156
156
},
157
157
"status": {
158
158
"type": "string",
159
159
"description": "Current availability. Known values: 'live', 'beta', 'coming' (announced but not yet playable), 'archived' (no longer available). Open set; portals may badge or filter on these.",
160
160
"knownValues": [
161
161
"live",
162
162
"beta",
163
163
"coming",
164
164
"archived"
165
165
]
166
166
},
167
167
"catalog": {
168
168
"type": "array",
169
169
"items": {
170
170
"ref": "#catalogRef",
171
171
"type": "ref"
172
172
},
173
173
"maxLength": 8,
174
174
"description": "Optional links to records in other game catalogs that describe this same title, most often a Pentaract (games.gamesgamesgamesgames.game) entry. This is how a definition borrows rich metadata a dedicated catalog already maintains, genres, platforms, screenshots, release dates, ratings, instead of duplicating it here. Purely supplementary: evaluation never reads these, and the experience is complete without them. Cooperate, don't re-enter."
175
175
},
176
176
"tagline": {
177
177
"type": "string",
178
178
"maxLength": 200,
179
179
"description": "One-line summary shown beneath the title in card views."
180
180
},
181
181
"category": {
182
182
"type": "string",
183
183
"maxLength": 30,
184
184
"description": "Broad type of experience, used for portal filtering and display. Known values: 'browser' (plays in a web browser), 'download' (downloaded and run locally), 'physical' (tabletop or in-person), 'other'. This is an open set, portals should tolerate values they do not recognise.",
185
185
"knownValues": [
186
186
"browser",
187
187
"download",
188
188
"physical",
189
189
"other"
190
190
]
191
191
},
192
192
"includes": {
193
193
"type": "array",
194
194
"items": {
195
195
"ref": "#lexiconRef",
196
196
"type": "ref"
197
197
},
198
198
"maxLength": 24,
199
199
"description": "Deprecated compatibility field. Use uses[] instead. Older records used includes[] for optional player-facing records that change or enrich gameplay when present."
200
200
},
201
201
"requires": {
202
202
"type": "array",
203
203
"items": {
204
204
"ref": "#rule",
205
205
"type": "ref"
206
206
},
207
207
"maxLength": 16,
208
208
"description": "Hard playability requirements. Every rule must pass before the game can be played as declared. Do not put recommendations, bonuses, or merely supported records here. Portals surface failures as actionable prompts using each rule's 'acquire' link."
209
209
},
210
210
"trailers": {
211
211
"type": "array",
212
212
"items": {
213
213
"ref": "#video",
214
214
"type": "ref"
215
215
},
216
216
"maxLength": 8,
217
217
"description": "Video trailers and gameplay clips. Hosted externally (YouTube, Vimeo, Twitch) or linked directly so portals can embed or link them."
218
218
},
219
219
"createdAt": {
220
220
"type": "string",
221
221
"format": "datetime"
222
222
},
223
223
"developer": {
224
224
"ref": "#party",
225
225
"type": "ref",
226
226
"description": "The studio or individual who built the experience. Prefer a DID when available so the developer is verifiable on the network."
227
227
},
228
228
"legacyIds": {
229
229
"type": "array",
230
230
"items": {
231
231
"type": "string",
232
232
"maxLength": 80
233
233
},
234
234
"maxLength": 12,
235
235
"description": "Stable identifiers used by older catalogues, score readers, or inventory integrations for this same game. These are compatibility aliases, not canonical identity."
236
236
},
237
237
"publisher": {
238
238
"type": "string",
239
239
"format": "at-uri",
240
240
"description": "Stable AT-URI identifying the account that publishes and maintains this definition, normally at:// followed by the publishing DID. It must name the same repository that contains this record; portals should reject a mismatch."
241
241
},
242
242
"updatedAt": {
243
243
"type": "string",
244
244
"format": "datetime"
245
245
},
246
246
"references": {
247
247
"type": "array",
248
248
"items": {
249
249
"ref": "#reference",
250
250
"type": "ref"
251
251
},
252
252
"maxLength": 24,
253
253
"description": "Deprecated compatibility field. Use uses[] instead. Older records used references[] for non-gating stat, save, activity, replay, leaderboard, validation, label, grant, profile, or portal-readable context."
254
254
},
255
255
"releasedAt": {
256
256
"type": "string",
257
257
"format": "datetime",
258
258
"description": "When this experience became publicly available."
259
259
},
260
260
"description": {
261
261
"type": "string",
262
262
"maxLength": 2000,
263
263
"description": "Full description of the experience. Plain text; portals may render line breaks."
264
264
},
265
265
"statNamespace": {
266
266
"type": "string",
267
267
"maxLength": 80,
268
-
"description": "Deprecated compatibility hint. Use references[] with role 'activity' or 'stats' to describe player activity records and display metrics."
268
+
"description": "Deprecated compatibility hint. Use uses[] with role 'activity' or 'stats' to describe player activity records and display metrics."
269
269
}
270
270
}
271
271
},
272
272
"description": "Published to the publisher's own repository, one record per game. Use a stable, readable record key and update that same record in place. The record's at:// URI is its canonical identity; 'url' is an access location and may change. A portal must not merge definitions solely because their URLs match."
273
273
},
274
274
"rule": {
275
275
"type": "object",
276
276
"required": [
277
277
"check"
278
278
],
279
279
"properties": {
280
280
"op": {
281
281
"type": "string",
282
282
"description": "For field: comparison operator.",
283
283
"knownValues": [
284
284
"exists",
285
285
"notExists",
286
286
"isViewer",
287
287
"eq",
288
288
"neq",
289
289
"gt",
290
290
"gte",
291
291
"lt",
292
292
"lte"
293
293
]
294
294
},
295
295
"nsid": {
296
296
"type": "string",
297
297
"format": "nsid",
298
298
"description": "Collection read by record, field, matches, or vouch."
299
299
},
300
300
"rkey": {
301
301
"type": "string",
302
302
"maxLength": 50,
303
303
"description": "For field: record key, default 'self'; 'any' scans the collection."
304
304
},
305
305
"rule": {
306
306
"ref": "#rule",
307
307
"type": "ref",
308
308
"description": "For not: nested rule to negate."
309
309
},
310
310
"check": {
311
311
"type": "string",
312
312
"description": "Rule discriminator. Known values are open for forward compatibility; an unknown value must not pass.",
313
313
"knownValues": [
314
314
"record",
315
315
"field",
316
316
"matches",
317
317
"vouch",
318
318
"all",
319
319
"any",
320
320
"not"
321
321
]
322
322
},
323
323
"field": {
324
324
"type": "string",
325
325
"maxLength": 200,
326
326
"description": "For field: dot-path to test."
327
327
},
328
328
"label": {
329
329
"type": "string",
330
330
"maxLength": 120,
331
331
"description": "Human-readable requirement."
332
332
},
333
333
"rules": {
334
334
"type": "array",
335
335
"items": {
336
336
"ref": "#rule",
337
337
"type": "ref"
338
338
},
339
339
"maxLength": 16,
340
340
"minLength": 1,
341
341
"description": "For all or any: nested rules."
342
342
},
343
343
"acquire": {
344
344
"type": "string",
345
345
"format": "uri",
346
346
"description": "URL where a player can fulfil this requirement."
347
347
},
348
348
"filters": {
349
349
"type": "array",
350
350
"items": {
351
351
"ref": "#filter",
352
352
"type": "ref"
353
353
},
354
354
"maxLength": 8,
355
355
"minLength": 1,
356
356
"description": "For matches or vouch: conditions that must hold on one record."
357
357
},
358
358
"authority": {
359
359
"type": "string",
360
360
"format": "did",
361
361
"description": "For vouch: stable DID of the record issuer."
362
362
},
363
363
"valueString": {
364
364
"type": "string",
365
365
"maxLength": 1000,
366
366
"description": "String comparison value."
367
367
},
368
368
"valueBoolean": {
369
369
"type": "boolean",
370
370
"description": "Boolean comparison value."
371
371
},
372
372
"valueInteger": {
373
373
"type": "integer",
374
374
"description": "Integer comparison value."
375
375
}
376
376
},
377
377
"description": "One recursive playability rule, discriminated by 'check'. Lexicon does not permit a union as a top-level definition, so this object carries the fields used by all seven variants. Evaluators enforce each variant's required fields: record(check,nsid); field(check,nsid,field,op); matches(check,nsid,filters); vouch(check,authority,nsid); all/any(check,rules); not(check,rule). Unknown check values evaluate as unknown, never as pass."
378
378
},
379
379
"field": {
380
380
"type": "object",
381
381
"required": [
382
382
"check",
383
383
"nsid",
384
384
"field",
385
385
"op"
386
386
],
387
387
"properties": {
388
388
"op": {
389
389
"type": "string",
390
390
"description": "How to test the field. exists/notExists check presence; eq/neq/gt/gte/lt/lte compare to a value; isViewer matches the signed-in player by their account ID (DID) and takes no value.",
391
391
"knownValues": [
392
392
"exists",
393
393
"notExists",
394
394
"isViewer",
395
395
"eq",
396
396
"neq",
397
397
"gt",
398
398
"gte",
399
399
"lt",
400
400
"lte"
401
401
]
402
402
},
403
403
"nsid": {
404
404
"type": "string",
405
405
"format": "nsid"
406
406
},
407
407
"rkey": {
408
408
"type": "string",
409
409
"maxLength": 50,
410
410
"description": "Record key. Defaults to 'self'. Use 'any' to pass if any record in the collection satisfies the condition."
411
411
},
412
412
"check": {
413
413
"type": "string",
414
414
"const": "field"
415
415
},
416
416
"field": {
417
417
"type": "string",
418
418
"maxLength": 200,
419
419
"description": "Dot-path to the property to evaluate (e.g. 'score.total', 'level'). Array traversal is not supported."
420
420
},
421
421
"label": {
422
422
"type": "string",
423
423
"maxLength": 120
424
424
},
425
425
"acquire": {
426
426
"type": "string",
427
427
"format": "uri"
428
428
},
429
429
"valueString": {
430
430
"type": "string",
431
431
"maxLength": 1000,
432
432
"description": "String comparison value. For value-taking operators, set exactly one of valueString, valueInteger, or valueBoolean."
433
433
},
434
434
"valueBoolean": {
435
435
"type": "boolean",
436
436
"description": "Boolean comparison value."
437
437
},
438
438
"valueInteger": {
439
439
"type": "integer",
440
440
"description": "Integer comparison value. Use for numeric gt/gte/lt/lte checks."
441
441
}
442
442
},
443
443
"description": "Fetches a record from the player's repository and tests one field. Covers required fields, score thresholds, flags, and enum matches."
444
444
},
445
445
"party": {
446
446
"type": "object",
447
447
"required": [
448
448
"name"
449
449
],
450
450
"properties": {
451
451
"did": {
452
452
"type": "string",
453
453
"format": "did",
454
454
"description": "AT Protocol DID of this entity's account, if they have one. On an atmosphere.games-managed provisional definition, this is also the DID expected to publish the canonical developer-owned definition."
455
455
},
456
456
"url": {
457
457
"type": "string",
458
458
"format": "uri",
459
459
"description": "Website for this entity."
460
460
},
461
461
"name": {
462
462
"type": "string",
463
463
"maxLength": 100,
464
464
"description": "Display name of the entity."
465
465
}
466
466
},
467
467
"description": "A named entity (developer, publisher, studio) associated with the experience."
468
468
},
469
469
"video": {
470
470
"type": "object",
471
471
"required": [
472
472
"title"
473
473
],
474
474
"properties": {
475
475
"url": {
476
476
"type": "string",
477
477
"format": "uri",
478
478
"description": "Full URL to the video, used when no platform/videoId is given."
479
479
},
480
480
"title": {
481
481
"type": "string",
482
482
"maxLength": 120,
483
483
"description": "Label for the clip (e.g. 'Launch Trailer')."
484
484
},
485
485
"videoId": {
486
486
"type": "string",
487
487
"maxLength": 120,
488
488
"description": "Platform video id (e.g. a YouTube id). Combined with 'platform' to build an embed."
489
489
},
490
490
"platform": {
491
491
"type": "string",
492
492
"description": "Where the video lives. 'direct' means the url points straight at a video file or page.",
493
493
"knownValues": [
494
494
"youtube",
495
495
"vimeo",
496
496
"twitch",
497
497
"direct"
498
498
]
499
499
},
500
500
"thumbnail": {
501
501
"type": "blob",
502
502
"accept": [
503
503
"image/png",
504
504
"image/jpeg",
505
505
"image/webp"
506
506
],
507
507
"maxSize": 2000000,
508
508
"description": "Optional still frame shown before the video plays."
509
509
}
510
510
},
511
511
"description": "A trailer or gameplay clip. Provide a platform + videoId (preferred, so portals embed natively) or a direct url."
512
512
},
513
513
"vouch": {
514
514
"type": "object",
515
515
"required": [
516
516
"check",
517
517
"authority",
518
518
"nsid"
519
519
],
520
520
"properties": {
521
521
"nsid": {
522
522
"type": "string",
523
523
"format": "nsid",
524
524
"description": "The kind of record to look for in that account's repo (e.g. equipment.rpg.give)."
525
525
},
526
526
"check": {
527
527
"type": "string",
528
528
"const": "vouch"
529
529
},
530
530
"label": {
531
531
"type": "string",
532
532
"maxLength": 120
533
533
},
534
534
"acquire": {
535
535
"type": "string",
536
536
"format": "uri"
537
537
},
538
538
"filters": {
539
539
"type": "array",
540
540
"items": {
541
541
"ref": "#filter",
542
542
"type": "ref"
543
543
},
544
544
"maxLength": 8,
545
545
"description": "Conditions the record must meet, written exactly like a matches rule. Put the 'isViewer' operator on the field that names the player (e.g. recipient) to require the record reference the signed-in player; add value conditions (e.g. item equals jet_pack) to pin a specific grant. With no filters, any record of this kind on the authority's repo passes."
546
546
},
547
547
"authority": {
548
548
"type": "string",
549
549
"format": "did",
550
550
"description": "Stable DID of the account that issues the record (for example an item provider, guild, or tournament organiser). Handles are not accepted because they are mutable. A player can never be their own authority."
551
551
}
552
552
},
553
553
"description": "Passes when a trusted account's repo holds a record that meets the given conditions, optionally one that references the signed-in player. Because the record lives on the issuer's repo, not the player's, it cannot be forged. Use it for item grants, awards, memberships, approvals, licences, or any record one account publishes about another. Example: 'games.protoimsg.app has an equipment.rpg.give whose recipient is this player and whose item is jet_pack.'"
554
554
},
555
555
"filter": {
556
556
"type": "object",
557
557
"required": [
558
558
"field",
559
559
"op"
560
560
],
561
561
"properties": {
562
562
"op": {
563
563
"type": "string",
564
564
"description": "How to test the field. exists/notExists check presence; eq/neq/gt/gte/lt/lte compare to a value; isViewer matches the signed-in player by their account ID (DID) and takes no value.",
565
565
"knownValues": [
566
566
"exists",
567
567
"notExists",
568
568
"isViewer",
569
569
"eq",
570
570
"neq",
571
571
"gt",
572
572
"gte",
573
573
"lt",
574
574
"lte"
575
575
]
576
576
},
577
577
"field": {
578
578
"type": "string",
579
579
"maxLength": 200,
580
580
"description": "Dot-path to the field."
581
581
},
582
582
"valueString": {
583
583
"type": "string",
584
584
"maxLength": 1000,
585
585
"description": "String comparison value. For value-taking operators, set exactly one typed value property."
586
586
},
587
587
"valueBoolean": {
588
588
"type": "boolean",
589
589
"description": "Boolean comparison value."
590
590
},
591
591
"valueInteger": {
592
592
"type": "integer",
593
593
"description": "Integer comparison value. Use for numeric gt/gte/lt/lte checks."
594
594
}
595
595
},
596
596
"description": "A single condition on a record's contents, used by matches and vouch. Most operators compare the field to a value. The special 'isViewer' operator takes no value and passes when the field identifies the signed-in player by their account ID (DID). It accepts the DID directly or an at:// URI whose repo is the player, and never matches on a handle, since handles can change. This is how a static definition points at whoever is reading it."
597
597
},
598
598
"record": {
599
599
"type": "object",
600
600
"required": [
601
601
"check",
602
602
"nsid"
603
603
],
604
604
"properties": {
605
605
"nsid": {
606
606
"type": "string",
607
607
"format": "nsid",
608
608
"description": "Collection to check on the player's PDS (e.g. 'actor.rpg.sprite')."
609
609
},
610
610
"check": {
611
611
"type": "string",
612
612
"const": "record"
613
613
},
614
614
"label": {
615
615
"type": "string",
616
616
"maxLength": 120,
617
617
"description": "Human-readable requirement shown when gated (e.g. 'An rpg.actor sprite')."
618
618
},
619
619
"acquire": {
620
620
"type": "string",
621
621
"format": "uri",
622
622
"description": "URL to send players who fail, so they can fulfil the requirement."
623
623
}
624
624
},
625
625
"description": "Passes if the player's PDS holds at least one record in the given collection. The simplest gate: 'does this person participate in this lexicon at all?'"
626
626
},
627
627
"matches": {
628
628
"type": "object",
629
629
"required": [
630
630
"check",
631
631
"nsid",
632
632
"filters"
633
633
],
634
634
"properties": {
635
635
"nsid": {
636
636
"type": "string",
637
637
"format": "nsid"
638
638
},
639
639
"check": {
640
640
"type": "string",
641
641
"const": "matches"
642
642
},
643
643
"label": {
644
644
"type": "string",
645
645
"maxLength": 120
646
646
},
647
647
"acquire": {
648
648
"type": "string",
649
649
"format": "uri"
650
650
},
651
651
"filters": {
652
652
"type": "array",
653
653
"items": {
654
654
"ref": "#filter",
655
655
"type": "ref"
656
656
},
657
657
"maxLength": 8,
658
658
"minLength": 1,
659
659
"description": "All filters must match on the same record (AND semantics within one record)."
660
660
}
661
661
},
662
662
"description": "Scans the player's collection and passes if any single record satisfies all filters simultaneously. Use to find a record by content rather than by key, e.g. 'holds item X', 'has membership tier Y'."
663
663
},
664
664
"mediaItem": {
665
665
"type": "object",
666
666
"required": [
667
667
"image"
668
668
],
669
669
"properties": {
670
670
"alt": {
671
671
"type": "string",
672
672
"maxLength": 300,
673
673
"description": "Accessibility caption describing the image."
674
674
},
675
675
"type": {
676
676
"type": "string",
677
677
"description": "What kind of image this is, so portals can place it (e.g. 'banner' across the top, 'screenshot' in a gallery).",
678
678
"knownValues": [
679
679
"screenshot",
680
680
"banner",
681
681
"artwork",
682
682
"poster",
683
683
"background",
684
684
"logo",
685
685
"thumbnail"
686
686
]
687
687
},
688
688
"image": {
689
689
"type": "blob",
690
690
"accept": [
691
691
"image/png",
692
692
"image/jpeg",
693
693
"image/webp",
694
694
"image/gif"
695
695
],
696
696
"maxSize": 8000000,
697
697
"description": "The image blob, stored on the developer's PDS."
698
698
},
699
699
"width": {
700
700
"type": "integer",
701
701
"description": "Pixel width, if known, lets portals reserve layout space before the blob loads."
702
702
},
703
703
"height": {
704
704
"type": "integer",
705
705
"description": "Pixel height, if known."
706
706
}
707
707
},
708
708
"description": "One image in the experience's media gallery."
709
709
},
710
710
"recordUse": {
711
711
"type": "object",
712
712
"required": [
713
713
"role",
714
714
"nsid"
715
715
],
716
716
"properties": {
717
717
"nsid": {
718
718
"type": "string",
719
719
"format": "nsid",
720
720
"description": "Collection to read or use."
721
721
},
722
722
"path": {
723
723
"type": "string",
724
724
"maxLength": 200,
725
725
"description": "Optional dot-path to the relevant payload within the record, e.g. 'data' inside actor.rpg.stats/clunscannon."
726
726
},
727
727
"rkey": {
728
728
"type": "string",
729
729
"maxLength": 50,
730
730
"description": "Record key to read from a player's repo. Defaults to 'self'; use 'any' when a portal should scan the collection."
731
731
},
732
732
"role": {
733
733
"type": "string",
734
734
"description": "How this record is used. Player-benefit roles such as perk, character, cosmetic, bonus, and interoperability describe optional game behavior. Data roles such as stats, activity, leaderboard, save, replay, session, profile, inventory, grant, validation, and label describe records portals/tools may read or display.",
735
735
"knownValues": [
736
736
"perk",
737
737
"character",
738
738
"cosmetic",
739
739
"bonus",
740
740
"interoperability",
741
741
"stats",
742
742
"activity",
743
743
"leaderboard",
744
744
"save",
745
745
"replay",
746
746
"session",
747
747
"profile",
748
748
"inventory",
749
749
"grant",
750
750
"validation",
751
751
"label",
752
752
"other"
753
753
]
754
754
},
755
755
"label": {
756
756
"type": "string",
757
757
"maxLength": 120,
758
758
"description": "Human label for this use."
759
759
},
760
760
"verify": {
761
761
"ref": "#rule",
762
762
"type": "ref",
763
763
"description": "Optional rule that detects, authenticates, or validates this use. For player-benefit roles, it badges whether the benefit is available. For data roles, it badges whether the displayed record is trusted."
764
764
},
765
765
"acquire": {
766
766
"type": "string",
767
767
"format": "uri",
768
768
"description": "Optional URL where a player can create, obtain, or manage this record."
769
769
},
770
770
"display": {
771
771
"type": "array",
772
772
"items": {
773
773
"ref": "#referenceDisplay",
774
774
"type": "ref"
775
775
},
776
776
"maxLength": 8,
777
777
"description": "Small metrics a portal may render on cards or profiles."
778
778
},
779
779
"filters": {
780
780
"type": "array",
781
781
"items": {
782
782
"ref": "#filter",
783
783
"type": "ref"
784
784
},
785
785
"maxLength": 8,
786
786
"description": "Optional filters used when rkey is 'any' or authority is set. Conditions must match on one record."
787
787
},
788
788
"purpose": {
789
789
"type": "string",
790
790
"maxLength": 300,
791
791
"description": "Plain-language reason this record matters. This should say whether it unlocks a benefit, imports player data, stores progress, validates a score, or powers portal display."
792
792
},
793
793
"authority": {
794
794
"type": "string",
795
795
"format": "did",
796
796
"description": "When the referenced record lives in a trusted authority repo instead of the player's repo, this DID names that repo."
797
797
}
798
798
},
799
799
"description": "One non-required AT Protocol record relationship for this game. This single shape covers optional gameplay benefits and portal-readable data. Examples: role 'perk' for a Jetpack item that changes play; role 'character' for a sprite the game can import; role 'stats' for a score record portals can display; role 'validation' for an authority record that confirms a stat. Hard gates still belong in requires[]."
800
800
},
801
801
"reference": {
802
802
"type": "object",
803
803
"required": [
804
804
"role",
805
805
"nsid"
806
806
],
807
807
"properties": {
808
808
"nsid": {
809
809
"type": "string",
810
810
"format": "nsid",
811
811
"description": "Collection to read."
812
812
},
813
813
"path": {
814
814
"type": "string",
815
815
"maxLength": 200,
816
816
"description": "Optional dot-path to the relevant payload within the record, e.g. 'clunscannon' inside actor.rpg.stats/self."
817
817
},
818
818
"rkey": {
819
819
"type": "string",
820
820
"maxLength": 50,
821
821
"description": "Record key to read from a player's repo. Defaults to 'self'; use 'any' when a portal should scan the collection."
822
822
},
823
823
"role": {
824
824
"type": "string",
825
825
"description": "Why this collection is relevant. 'stats' and 'leaderboard' are for card summaries; 'activity' for player counts/recent activity; 'validation' for trusted attestations such as actor.rpg.master.",
826
826
"knownValues": [
827
827
"activity",
828
828
"stats",
829
829
"leaderboard",
830
830
"save",
831
831
"replay",
832
832
"session",
833
833
"profile",
834
834
"inventory",
835
835
"grant",
836
836
"validation",
837
837
"label",
838
838
"other"
839
839
]
840
840
},
841
841
"label": {
842
842
"type": "string",
843
843
"maxLength": 120,
844
844
"description": "Human label for this reference."
845
845
},
846
846
"verify": {
847
847
"ref": "#rule",
848
848
"type": "ref",
849
849
"description": "Optional rule that validates this reference before displaying it as trusted. Example: an actor.rpg.master vouch for a player's actor.rpg.stats system."
850
850
},
851
851
"acquire": {
852
852
"type": "string",
853
853
"format": "uri",
854
854
"description": "Optional URL where a player can create or manage this record."
855
855
},
856
856
"display": {
857
857
"type": "array",
858
858
"items": {
859
859
"ref": "#referenceDisplay",
860
860
"type": "ref"
861
861
},
862
862
"maxLength": 8,
863
863
"description": "Small metrics a portal may render on cards or profiles."
864
864
},
865
865
"filters": {
866
866
"type": "array",
867
867
"items": {
868
868
"ref": "#filter",
869
869
"type": "ref"
870
870
},
871
871
"maxLength": 8,
872
872
"description": "Optional filters used when rkey is 'any' or authority is set. Conditions must match on one record."
873
873
},
874
874
"purpose": {
875
875
"type": "string",
876
876
"maxLength": 300,
877
877
"description": "Why a portal or game reads this data."
878
878
},
879
879
"authority": {
880
880
"type": "string",
881
881
"format": "did",
882
882
"description": "When the referenced record lives in a trusted authority repo instead of the player's repo, this DID names that repo."
883
883
}
884
884
},
885
885
"description": "Deprecated compatibility shape for references[]. Use recordUse in uses[]. A non-gating record surface relevant to stats, saves, leaderboards, activity, sessions, replays, validation, labels, grants, inventory, profile enrichment, or other portal-readable context."
886
886
},
887
887
"catalogRef": {
888
888
"type": "object",
889
889
"required": [
890
890
"uri"
891
891
],
892
892
"properties": {
893
893
"uri": {
894
894
"type": "string",
895
895
"format": "at-uri",
896
896
"description": "AT-URI of the external catalog record (e.g. at://did:web:gamesgamesgamesgames.games/games.gamesgamesgamesgames.game/3mgjih2bzdp2l)."
897
897
},
898
898
"name": {
899
899
"type": "string",
900
900
"maxLength": 100,
901
901
"description": "Display name of the referenced entry, so portals can show it without resolving the record."
902
902
},
903
903
"borrow": {
904
904
"type": "array",
905
905
"items": {
906
906
"type": "string",
907
907
"knownValues": [
908
908
"media",
909
909
"trailers",
910
910
"genres",
911
911
"platforms",
912
912
"releases",
913
913
"ratings",
914
914
"description",
915
915
"summary"
916
916
]
917
917
},
918
918
"maxLength": 8,
919
919
"description": "Advisory hints naming which parts of the referenced record a portal may display alongside this experience (e.g. pull screenshots and genres from Pentaract rather than duplicating them here). Display guidance only, never affects eligibility."
920
920
},
921
921
"source": {
922
922
"type": "string",
923
923
"maxLength": 60,
924
924
"description": "Short label for the catalog this points at (e.g. 'pentaract')."
925
925
}
926
926
},
927
927
"description": "A pointer to a record in another catalog that already describes this title in depth, most usefully a games.gamesgamesgamesgames.game record on The Pentaract, which carries genres, platforms, release dates, age ratings, and a full media gallery. The definition stays self-contained (eligibility never depends on it); the reference simply lets a portal fetch that richer metadata and show it alongside, so we build on existing game databases instead of re-entering everything."
928
928
},
929
929
"lexiconRef": {
930
930
"type": "object",
931
931
"required": [
932
932
"nsid"
933
933
],
934
934
"properties": {
935
935
"nsid": {
936
936
"type": "string",
937
937
"format": "nsid"
938
938
},
939
939
"verify": {
940
940
"ref": "#rule",
941
941
"type": "ref",
942
942
"description": "Optional rule that detects or authenticates this feature, typically a player-record match or a vouch in an issuer's separate grant collection. Portals may badge the feature when it passes. It never gates access."
943
943
},
944
944
"acquire": {
945
945
"type": "string",
946
946
"format": "uri",
947
947
"description": "Optional URL where a player can obtain this record."
948
948
},
949
949
"purpose": {
950
950
"type": "string",
951
951
"maxLength": 200,
952
952
"description": "The player-visible benefit this record unlocks or enriches when present. Shown to players."
953
953
}
954
954
},
955
955
"description": "Deprecated compatibility shape for includes[]. Use recordUse in uses[]. An optional player-facing record collection this game can use when present."
956
956
},
957
957
"referenceDisplay": {
958
958
"type": "object",
959
959
"required": [
960
960
"key",
961
961
"label",
962
962
"path"
963
963
],
964
964
"properties": {
965
965
"key": {
966
966
"type": "string",
967
967
"maxLength": 80,
968
968
"description": "Stable metric key within this definition, e.g. 'bestDistance'."
969
969
},
970
970
"path": {
971
971
"type": "string",
972
972
"maxLength": 200,
973
973
"description": "Dot-path to the value, relative to the reference path when set."
974
974
},
975
975
"unit": {
976
976
"type": "string",
977
977
"maxLength": 20,
978
978
"description": "Unit suffix such as 'm', 'XP', or 'pts'."
979
979
},
980
980
"label": {
981
981
"type": "string",
982
982
"maxLength": 80,
983
983
"description": "Short label shown before or beside the value."
984
984
},
985
985
"format": {
986
986
"type": "string",
987
987
"description": "Presentation hint for the value.",
988
988
"knownValues": [
989
989
"string",
990
990
"integer",
991
991
"number",
992
992
"distance",
993
993
"percent",
994
994
"duration",
995
995
"datetime",
996
996
"boolean"
997
997
]
998
998
},
999
999
"divideBy": {
1000
1000
"type": "integer",
1001
1001
"minimum": 1,
1002
1002
"description": "Integer divisor applied before display, e.g. divideBy 10 for decimeters to meters."
1003
1003
},
1004
1004
"priority": {
1005
1005
"type": "integer",
1006
1006
"description": "Lower numbers display first."
1007
1007
},
1008
1008
"aggregate": {
1009
1009
"type": "string",
1010
1010
"description": "How to reduce multiple records. Defaults to 'first' for fixed rkey records and 'count' for collection scans.",
1011
1011
"knownValues": [
1012
1012
"first",
1013
1013
"count",
1014
1014
"max",
1015
1015
"min",
1016
1016
"sum",
1017
1017
"latest",
1018
1018
"exists"
1019
1019
]
1020
1020
},
1021
1021
"multiplyBy": {
1022
1022
"type": "integer",
1023
1023
"description": "Integer multiplier applied before display. Use with divideBy for rational scaling."
1024
1024
},
1025
1025
"maximumFractionDigits": {
1026
1026
"type": "integer",
1027
1027
"maximum": 6,
1028
1028
"minimum": 0,
1029
1029
"description": "Decimal precision for numeric display."
1030
1030
}
1031
1031
},
1032
1032
"description": "A declarative display metric derived from a referenced record or collection. Portals may ignore unsupported formats or aggregates."
1033
1033
}
1034
1034
},
1035
1035
"$type": "com.atproto.lexicon.schema",
1036
1036
"lexicon": 1,
1037
1037
"description": "An AT Protocol game definition: a publisher's self-contained declaration of a playable experience, its presentation, the records a player must hold to play, and records the game can optionally use. Evaluators resolve requirements through AT Protocol repository reads; no game server or central eligibility database is required."
1038
1038
}