pet.trezy.species
Schema Diff
+23 -3
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 10 non-breaking changes.
Breaking Changes (1)
- ConstraintTightened ConstraintTightened { vertex_id: "pet.trezy.species#behavior.type", sort: "knownValues", old_value: "[\"idle\",\"move\",\"slide\",\"jump\"]", new_value: "[\"idle\",\"move\",\"slide\",\"jump\",\"fly\"]" }
Non-Breaking Changes (10)
- AddedVertex AddedVertex { vertex_id: "pet.trezy.species#behavior.hoverAnimation" }
- AddedVertex AddedVertex { vertex_id: "pet.trezy.species#sprite.box" }
- AddedVertex AddedVertex { vertex_id: "pet.trezy.species#sprite.portrait" }
- AddedVertex AddedVertex { vertex_id: "pet.trezy.species:body.starter" }
- AddedEdge AddedEdge { src: "pet.trezy.species#behavior", tgt: "pet.trezy.species#behavior.hoverAnimation", kind: "prop", name: Some("hoverAnimation") }
- AddedEdge AddedEdge { src: "pet.trezy.species#sprite", tgt: "pet.trezy.species#sprite.box", kind: "prop", name: Some("box") }
- AddedEdge AddedEdge { src: "pet.trezy.species#sprite", tgt: "pet.trezy.species#sprite.portrait", kind: "prop", name: Some("portrait") }
- AddedEdge AddedEdge { src: "pet.trezy.species#sprite.box", tgt: "pet.trezy.species#size", kind: "ref", name: None }
- AddedEdge AddedEdge { src: "pet.trezy.species#sprite.portrait", tgt: "pet.trezy.species#size", kind: "ref", name: None }
- AddedEdge AddedEdge { src: "pet.trezy.species:body", tgt: "pet.trezy.species:body.starter", kind: "prop", name: Some("starter") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "pet.trezy.species#behavior.hoverAnimation" }AddedVertex { vertex_id: "pet.trezy.species#sprite.box" }AddedVertex { vertex_id: "pet.trezy.species#sprite.portrait" }AddedVertex { vertex_id: "pet.trezy.species:body.starter" }
Constraint Changes
- ConstraintTightened ConstraintTightened { vertex_id: "pet.trezy.species#behavior.type", sort: "knownValues", old_value: "[\"idle\",\"move\",\"slide\",\"jump\"]", new_value: "[\"idle\",\"move\",\"slide\",\"jump\",\"fly\"]" }
Additional Notes
- Non-breaking: AddedEdge { src: "pet.trezy.species#behavior", tgt: "pet.trezy.species#behavior.hoverAnimation", kind: "prop", name: Some("hoverAnimation") }
- Non-breaking: AddedEdge { src: "pet.trezy.species#sprite", tgt: "pet.trezy.species#sprite.box", kind: "prop", name: Some("box") }
- Non-breaking: AddedEdge { src: "pet.trezy.species#sprite", tgt: "pet.trezy.species#sprite.portrait", kind: "prop", name: Some("portrait") }
- Non-breaking: AddedEdge { src: "pet.trezy.species#sprite.box", tgt: "pet.trezy.species#size", kind: "ref", name: None }
- Non-breaking: AddedEdge { src: "pet.trezy.species#sprite.portrait", tgt: "pet.trezy.species#size", kind: "ref", name: None }
- Non-breaking: AddedEdge { src: "pet.trezy.species:body", tgt: "pet.trezy.species:body.starter", kind: "prop", name: Some("starter") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"animation": {
5
5
"properties": {
6
6
"frames": {
7
7
"items": {
8
8
"ref": "#frame",
9
9
"type": "ref"
10
10
},
11
11
"minLength": 1,
12
12
"type": "array"
13
13
},
14
14
"name": {
15
15
"description": "The tag name from Aseprite — `idle`, `run`, `slide-loop`. Behaviours reference these by name, and a behaviour naming an animation that is not here does not throw: the pet simply stops animating. build-species.ts refuses to emit that combination.",
16
16
"maxLength": 64,
17
17
"type": "string"
18
18
}
19
19
},
20
20
"required": [
21
21
"name",
22
22
"frames"
23
23
],
24
24
"type": "object"
25
25
},
26
26
"behavior": {
27
27
"description": "One weighted option in the behaviour tree. The params a type needs differ by type, which lexicon cannot express as a discriminated union, so every param is optional here and build-species.ts validates the combination that each type actually requires.",
28
28
"properties": {
29
29
"animation": {
30
30
"description": "For `idle` and `move`: the animation to play throughout.",
31
31
"maxLength": 64,
32
32
"type": "string"
33
33
},
34
34
"endAnimation": {
35
35
"description": "For `slide` and `jump`: the recovery, played once.",
36
36
"maxLength": 64,
37
37
"type": "string"
38
38
},
39
39
"endMoveFrame": {
40
40
"description": "For `jump`: the frame of the end animation at which it lands.",
41
41
"minimum": 0,
42
42
"type": "integer"
43
43
},
44
+
"hoverAnimation": {
45
+
"description": "For `fly`: held on the spot after arriving somewhere, before it picks the next destination or comes down. Optional — a species without one simply turns and goes again.",
46
+
"maxLength": 64,
47
+
"type": "string"
48
+
},
44
49
"loopAnimation": {
45
50
"description": "For `slide` and `jump`: the sustained middle, repeated while travelling.",
46
51
"maxLength": 64,
47
52
"type": "string"
48
53
},
49
54
"maxDuration": {
50
-
"description": "For `idle`: seconds, the longest.",
55
+
"description": "For `idle`: seconds, the longest. For `fly`: the longest it stays up.",
51
56
"minimum": 0,
52
57
"type": "integer"
53
58
},
54
59
"minDuration": {
55
-
"description": "For `idle`: seconds, the shortest the pet will stand still.",
60
+
"description": "For `idle`: seconds, the shortest the pet will stand still. For `fly`: seconds aloft before it looks for somewhere to land.",
56
61
"minimum": 0,
57
62
"type": "integer"
58
63
},
59
64
"speed": {
60
65
"description": "World pixels per second. Characterisation rather than realism — the turtle is slow because a slow turtle is funny, and the spread across species is what makes a mixed stage read as a menagerie.",
61
66
"minimum": 0,
62
67
"type": "integer"
63
68
},
64
69
"startAnimation": {
65
70
"description": "For `slide` and `jump`: the wind-up, played once.",
66
71
"maxLength": 64,
67
72
"type": "string"
68
73
},
69
74
"startMoveFrame": {
70
75
"description": "For `jump`: the frame of the start animation at which the pet actually leaves the ground, so the launch matches the drawing.",
71
76
"minimum": 0,
72
77
"type": "integer"
73
78
},
74
79
"type": {
75
80
"description": "NOT an enum, for the same reason `tier` is not: a new behaviour should be publishable. A client that meets a type it does not implement must skip that option and keep the rest, never refuse the species.",
76
81
"knownValues": [
77
82
"idle",
78
83
"move",
79
84
"slide",
80
-
"jump"
85
+
"jump",
86
+
"fly"
81
87
],
82
88
"maxLength": 32,
83
89
"type": "string"
84
90
},
85
91
"weight": {
86
92
"description": "Relative likelihood against the species's other options. Zero is a legitimate way to keep a behaviour published but dormant.",
87
93
"minimum": 0,
88
94
"type": "integer"
89
95
}
90
96
},
91
97
"required": [
92
98
"type",
93
99
"weight"
94
100
],
95
101
"type": "object"
96
102
},
97
103
"datum": {
98
104
"properties": {
99
105
"key": {
100
106
"maxLength": 64,
101
107
"type": "string"
102
108
},
103
109
"value": {
104
110
"maxLength": 256,
105
111
"type": "string"
106
112
}
107
113
},
108
114
"required": [
109
115
"key",
110
116
"value"
111
117
],
112
118
"type": "object"
113
119
},
114
120
"frame": {
115
121
"description": "One frame: where it sits in the atlas, and how long it is held.",
116
122
"properties": {
117
123
"duration": {
118
124
"description": "Milliseconds, as Aseprite exports it.",
119
125
"minimum": 1,
120
126
"type": "integer"
121
127
},
122
128
"h": {
123
129
"minimum": 1,
124
130
"type": "integer"
125
131
},
126
132
"w": {
127
133
"minimum": 1,
128
134
"type": "integer"
129
135
},
130
136
"x": {
131
137
"minimum": 0,
132
138
"type": "integer"
133
139
},
134
140
"y": {
135
141
"minimum": 0,
136
142
"type": "integer"
137
143
}
138
144
},
139
145
"required": [
140
146
"x",
141
147
"y",
142
148
"w",
143
149
"h",
144
150
"duration"
145
151
],
146
152
"type": "object"
147
153
},
148
154
"main": {
149
155
"description": "A species the game knows about, published in the game's own repo (did:plc:ollch4g7tes2reb5eceiwuol). Only records from that DID are ever read — record.index:pet.trezy.species refuses the rest. THIS RECORD IS THE WHOLE SPECIES: identity, economy, artwork and temperament. The client compiles in nothing about any species and derives nothing from a filename; it draws what these records say and caches the answer. A species not published here does not exist to the game, and changing one here changes it for every client without an app deploy.",
150
156
"key": "any",
151
157
"record": {
152
158
"properties": {
153
159
"activity": {
154
160
"description": "When the animal keeps its hours. ⚠ A FIELD RATHER THAN A GROUP, BECAUSE THESE ARE MUTUALLY EXCLUSIVE AND GROUPS ARE NOT. `groups` overlap on purpose — a bat is a mammal and a flier at once — so nothing there can enforce exactly-one, and a species tagged both `nocturnal` and `diurnal` would be nonsense no reader could resolve. It also has to be exactly one for the mechanic that will read it: a pet dozes outside its own hours, and 'outside' is undefined for an animal with two answers.\n\nThe vocabulary, widest first: `diurnal` is daylight; `nocturnal` is night; `crepuscular` is both twilights; `matutinal` is dawn ONLY and `vespertinal` is dusk ONLY, the two halves crepuscular rolls together; `cathemeral` is no fixed rhythm, which is the honest answer for a slime.\n\n⚠ `matutinal` AND `vespertinal` ARE PUBLISHED AHEAD OF ANY USER, DELIBERATELY. No species on the roster is either one today. They are listed so the vocabulary is settled before somebody needs it — a reader implementing dozing should handle all six now rather than discover two of them later. NOT an enum, for the same reason `tier` is not: the list documents what exists and constrains nothing, so a seventh is a record edit rather than a client deploy.\n\n(Spelled `vespertinal` to match the -al pattern of the others; `vespertine` is the commoner form in the literature and means the same thing. Do not 'correct' one to the other — the string is stored on records.)",
155
161
"knownValues": [
156
162
"diurnal",
157
163
"nocturnal",
158
164
"crepuscular",
159
165
"matutinal",
160
166
"vespertinal",
161
167
"cathemeral"
162
168
],
163
169
"maxLength": 64,
164
170
"type": "string"
165
171
},
166
172
"behaviors": {
167
173
"description": "How the species acts when left alone, as weighted options for the behaviour tree. Authored, unlike `sprite` — this is temperament, a game-design judgement that no export contains.",
168
174
"items": {
169
175
"ref": "#behavior",
170
176
"type": "ref"
171
177
},
172
178
"minLength": 1,
173
179
"type": "array"
174
180
},
175
181
"displayName": {
176
182
"maxLength": 64,
177
183
"type": "string"
178
184
},
179
185
"groups": {
180
186
"description": "The `pet.trezy.group` records this species belongs to, by id. AN ARRAY BECAUSE MEMBERSHIP OVERLAPS AND MIXES LEVELS: a bat is `mammals`, `bats`, `fliers` and `nocturnal`, and a penguin is `birds` and `swimmers` without being a mammal at all. A single field would have forced a species to pick one true thing about itself and drop the others — which is why the vocabulary can hold a class, a family and a habit side by side rather than having to settle on one rank. Order is not significant; readers sort by the group's own `rank`.",
181
187
"items": {
182
188
"maxLength": 64,
183
189
"type": "string"
184
190
},
185
191
"type": "array"
186
192
},
187
193
"id": {
188
194
"description": "The species key. Stored on every ledger row already sold, so renaming one is not safe — a rename is a new species plus a migration, never an edit.",
189
195
"maxLength": 64,
190
196
"type": "string"
191
197
},
192
198
"price": {
193
199
"description": "Overrides the tier's price for this species alone. Absent is the normal case — an override per species would mean the tiers are wrong.",
194
200
"minimum": 0,
195
201
"type": "integer"
196
202
},
197
203
"purchasable": {
198
204
"description": "ABSENT MEANS TRUE. False means the species exists in every other sense — tier, sprite, ownable, on the leaderboard — but the shop will not sell it because it is reached another way. A reader writing `if purchasable then` makes every species unsellable.",
199
205
"type": "boolean"
200
206
},
201
207
"sprite": {
202
208
"description": "Everything needed to draw the animal, including the atlas itself as a blob. Generated from the artist's Aseprite export by scripts/build-species.ts and never hand-edited.",
203
209
"ref": "#sprite",
204
210
"type": "ref"
205
211
},
212
+
"starter": {
213
+
"description": "Offered as a first pet. ABSENT MEANS NO, and the flag is a whitelist rather than a hint: when any species carries it, the starter picker offers exactly those and the price rule is not consulted. When none does, the picker falls back to everything the starter grant can afford, which is what it did before this field existed. Kept here rather than as a list on gameConfig because it is a fact about the species, and because a full species record already travels to every client in getDefinitions — a list elsewhere would need the query, its output lexicon and its Lua changed to say the same thing.",
214
+
"type": "boolean"
215
+
},
206
216
"tier": {
207
217
"description": "The id of a pet.trezy.tier record, which carries the price. Deliberately NOT an enum: adding a tier must be publishing one record, not editing this file, regenerating and redeploying the client. knownValues documents the tiers that exist today and constrains nothing.",
208
218
"knownValues": [
209
219
"common",
210
220
"uncommon",
211
221
"rare",
212
222
"epic",
213
223
"legendary"
214
224
],
215
225
"maxLength": 64,
216
226
"type": "string"
217
227
}
218
228
},
219
229
"required": [
220
230
"id",
221
231
"displayName",
222
232
"tier",
223
233
"sprite",
224
234
"behaviors"
225
235
],
226
236
"type": "object"
227
237
},
228
238
"type": "record"
229
239
},
230
240
"rect": {
231
241
"properties": {
232
242
"h": {
233
243
"minimum": 0,
234
244
"type": "integer"
235
245
},
236
246
"w": {
237
247
"minimum": 0,
238
248
"type": "integer"
239
249
},
240
250
"x": {
241
251
"type": "integer"
242
252
},
243
253
"y": {
244
254
"type": "integer"
245
255
}
246
256
},
247
257
"required": [
248
258
"x",
249
259
"y",
250
260
"w",
251
261
"h"
252
262
],
253
263
"type": "object"
254
264
},
255
265
"size": {
256
266
"properties": {
257
267
"h": {
258
268
"minimum": 1,
259
269
"type": "integer"
260
270
},
261
271
"w": {
262
272
"minimum": 1,
263
273
"type": "integer"
264
274
}
265
275
},
266
276
"required": [
267
277
"w",
268
278
"h"
269
279
],
270
280
"type": "object"
271
281
},
272
282
"slice": {
273
283
"properties": {
274
284
"bounds": {
275
285
"ref": "#rect",
276
286
"type": "ref"
277
287
},
278
288
"data": {
279
289
"description": "The slice's user-data, as key/value pairs. Aseprite stores this as a free-text string like `type=ground-contact`; it is split at build time so no reader has to. `type` is the only key the game reads today, and unknown keys are carried through rather than dropped.",
280
290
"items": {
281
291
"ref": "#datum",
282
292
"type": "ref"
283
293
},
284
294
"type": "array"
285
295
},
286
296
"name": {
287
297
"maxLength": 64,
288
298
"type": "string"
289
299
}
290
300
},
291
301
"required": [
292
302
"name",
293
303
"bounds"
294
304
],
295
305
"type": "object"
296
306
},
297
307
"sprite": {
298
308
"description": "The drawable half of a species. Mirrors the client's SpriteSheet shape exactly so the client does no parsing: it reads these fields straight into the renderer. The Aseprite JSON is NOT carried verbatim — that format numbers frames per tag and stores tag membership as index ranges into an insertion-ordered object, which has caused two separate animation bugs in this project. The ranges are resolved here, once, at build time.",
299
309
"properties": {
300
310
"animations": {
301
311
"description": "Named animations. AN ARRAY, NOT A MAP, because lexicon has no map type and an `unknown` blob here would put this back to being parsed by hand at both ends. The client keys it by name on read.",
302
312
"items": {
303
313
"ref": "#animation",
304
314
"type": "ref"
305
315
},
306
316
"minLength": 1,
307
317
"type": "array"
308
318
},
309
319
"atlas": {
310
320
"accept": [
311
321
"image/png"
312
322
],
313
323
"description": "The packed spritesheet PNG, stored in this repo. A blob rather than a URL into the app's public directory, so the artwork and the frame rectangles that index into it version together and CANNOT disagree — a repacked atlas with stale coordinates draws slivers of the wrong animal, which is the exact drift this record exists to end. Pixel-art atlases are a few KB; the cap is generous by three orders of magnitude and is only there to catch a mistake.",
314
324
"maxSize": 1000000,
315
325
"type": "blob"
316
326
},
327
+
"box": {
328
+
"description": "Tight opaque bounds across EVERY FRAME OF EVERY ANIMATION, in source pixels, with the creature centred on its ground contact. The box a crowd view packs cells from.\n\n⚠ MEASURED FROM THE ATLAS AT BUILD TIME, NEVER AUTHORED. It lived in the client as a 76-entry table for exactly as long as the client also held the art; once the art moved to its own repo nothing in the client could re-derive it, and a table of measurements nobody can check is a table that rots silently — a clipped ear, a crowd quietly back to overlapping.\n\n⚠ NOT `frameSize`, WHICH IS THE CANVAS RATHER THAN THE ANIMAL. Widths here run from 13 to 69 against a frame that is typically 64×64, so sizing a cell from the frame leaves a piglin swimming in five times its own area.\n\nOPTIONAL, AND ABSENCE IS NOT AN ERROR: a reader without it falls back to a box large enough for anything drawn. Records published before this field existed simply do not have it.",
329
+
"ref": "#size",
330
+
"type": "ref"
331
+
},
317
332
"frameSize": {
318
333
"description": "One frame's dimensions — the window the animal is drawn inside, typically 64×64 with the creature somewhere within it rather than filling it.",
319
334
"ref": "#size",
320
335
"type": "ref"
321
336
},
337
+
"portrait": {
338
+
"description": "Tight opaque bounds of the FIRST FRAME OF THE `idle` TAG alone, same centring as `box`. The crop a single-pet portrait uses.\n\n⚠ A SECOND MEASUREMENT RATHER THAN A DERIVATION OF `box`, BECAUSE ONE FRAME IS NOT THE LOOP. The widest animal reaches 69 across its full run and 59 on its idle frame; a portrait cropped to 69 leaves every pet floating, and a crowd cell sized at 59 clips the frames the idle pose does not reach. Neither number can be computed from the other.\n\nOPTIONAL on the same terms as `box`.",
339
+
"ref": "#size",
340
+
"type": "ref"
341
+
},
322
342
"size": {
323
343
"description": "The atlas's own pixel dimensions. Needed to place background-position offsets without waiting for the image to load.",
324
344
"ref": "#size",
325
345
"type": "ref"
326
346
},
327
347
"slices": {
328
348
"description": "Authored regions: the hitbox a pointer can grab, and the ground-contact box that decides where the animal's feet are. Absent or unlabelled slices fall back to a measured box, so this may be empty.",
329
349
"items": {
330
350
"ref": "#slice",
331
351
"type": "ref"
332
352
},
333
353
"type": "array"
334
354
}
335
355
},
336
356
"required": [
337
357
"atlas",
338
358
"size",
339
359
"frameSize",
340
360
"animations",
341
361
"slices"
342
362
],
343
363
"type": "object"
344
364
}
345
365
},
346
366
"id": "pet.trezy.species",
347
367
"lexicon": 1
348
368
}