Manifest

From Box Critters Modding Wiki
Jump to navigation Jump to search

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.

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     "name": "",
4     "type": "",
5     "images": [""],
6     "framerate": 10,
7     "frames": {[1,1,97,114,0,8,106],...},
8     "animations:{...}
9 }

[1]

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

symbols

1 {
2   "images": [...],
3   "framerate": 24,
4   "frames": [...],
5   "animations": {...}
6 }

[2]

images

this is the path to the texture file of the symbols

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 {
2   "images": [...],
3   "framerate": 20,
4   "frames": [...],
5   "animations": {...}
6 }

[3]

images

this is the path to the texture file of the symbols

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

items

1 {
2    "version": 2,
3    "build":"itemsId",
4    "frames": [...],
5    "items" :{...}
6 }

[4]

version

build

frames

this denotes the positions of the frames in the texture file

items

1 "itemId": {
2    "front": [...],
3    "back":[...]
4 }

[4]

front

frames that appear when in front of the critter.

back (optional)

frames that appear when behind the critter.

Rooms

 1 {
 2 	"RoomId": "",
 3 	"Name": "",
 4 	"Background" "",
 5 	"Foreground": "",
 6 	"SpriteSheet": {
 7 		"images":"",
 8 		"framerate":"",
 9 		"frames":[[...]],
10 		"animations":{},
11 		"texturepacker": []
12 	},
13 	"Layout": {
14 		"Background": [...],
15 		"Foreground": [...],
16 		"Playground": [...]
17 	},
18 	"Triggers": []
19 }

[5]

RoomId

Name

Background

Foreground

Playground

spritesheet

Layout

Triggers

References

  1. BoxCritters (2019) Critters Manifest. [online] Available at: https://boxcritters.com/media/critters9.json [Accessed 19/12/2019]
  2. BoxCritters (2019) Symbols Manifest. [online] Available at: https://boxcritters.com/media/symbols/symbols.json [Accessed 19/20/2019]
  3. BoxCritters (2019) Effects Manifest. [online] Available at: https://boxcritters.com/media/effects/effects2.json [Accessed 19/12/2019]
  4. 4.0 4.1 BoxCritters (2019) Items Manifest. [online] Available at: https://boxcritters.com/media/items/cbbd5b5b6f8dac6f4a3030dab9ebd0a7/items.json [Accessed 19/12/2019]
  5. BoxCritters (2020) Rooms Manifest. [online] Available at: http://boxcritters.com/media/rooms/202003-lucky/rooms.json [Accessed 13/03/2020]