Manifest
A manifest is a json file that tells boxcritters what textures to load. Each of the types of things including critters, symbols, effects and items have their own manifest file.
Contents
Sprites
1 {
2 "images":["..."],
3 "framerate":123,
4 "frames":[[123]],
5 "animations":{
6 "THING":{
7 "frames":[123]
8 }
9 }
10 }
critters
The critters manifest is an array and each object in the array represents a specific critter in box critters. The layout for each critter goes as follows.
1 [{
2 "CritterID": "..",
3 "Created":"yyyy-mm-dd",
4 "LastModified":"yyyy-mm-ddThh-mm-ss.000Z",
5 "Sprites":{Sprite}
6 }]
1 [{
2 "MascotID": "..",
3 "Framerate":10,
4 "Created":"yyyy-mm-dd",
5 "LastModified":"yyyy-mm-ddThh-mm-ss.000Z",
6 "Sprites":{Sprite}
7 }]
critterId
critter id is the camel case version of the critter type that is used when referencing the critter in code
name
this is the human readable version that can be used in guis and stiff
type
this is the type of critter. currently the only types are: critter and mascot
images
this is the path to the texture file of the critter
framerate
this is how fast to switch frames
frames
this denotes the positions of the frames in the texture file
animations
this lists the types of animations and the frames that should be used
effects
1 {Sprite}
items
1 {
2 "Items":[{
3 "ItemId": "...",
4 "Name": "...",
5 "Theme": "...",
6 "Slot": "..."
7 }],
8 "Sprites":{Sprite}
9 }]
ItemID
Name
Theme
Slot
front
frames that appear when in front of the critter.
back (optional)
frames that appear when behind the critter.
Rooms
1 [{
2 "RoomID": "..",
3 "Framerate":123,
4 "Created":"yyyy-mm-dd",
5 "LastModified":"yyyy-mm-ddThh-mm-ss.000Z",
6 "Width":123,
7 "Height":123,
8 "StartX":123,
9 "StartY":123,
10 "StartR":123,
11 "Sprites":{Sprite},
12 "Layout":{
13 "Playground":[{//Maybe Make seperate section about "Layout"
14 "id": "...",
15 "name": "...",
16 "w": 123,
17 "h": 123,
18 "x": 123,
19 "y": 123,
20 "regX": 123,
21 "regY": 123
22 }]
23 },
24 "Triggers":[{
25 "hex": "abc123",
26 "hide": ["..."]
27 }],
28 "Sprites":{Sprite},
29 "Background":"...",
30 "Foreground":"...",
31 "NavMesh":"...",
32 "Map":"..."
33 }]
RoomId
Name
Background
Foreground
Playground
spritesheet
Layout
Triggers
References
- ↑ BoxCritters (2019) Critters Manifest. [online] Available at: https://boxcritters.com/media/critters9.json [Accessed 19/12/2019]
- ↑ BoxCritters (2019) Effects Manifest. [online] Available at: https://boxcritters.com/media/effects/effects2.json [Accessed 19/12/2019]
- ↑ BoxCritters (2019) Items Manifest. [online] Available at: https://boxcritters.com/media/items/cbbd5b5b6f8dac6f4a3030dab9ebd0a7/items.json [Accessed 19/12/2019]
- ↑ BoxCritters (2020) Rooms Manifest. [online] Available at: http://boxcritters.com/media/rooms/202003-lucky/rooms.json [Accessed 13/03/2020]
