Manifest

*Our community needs more information on this page! Can you help out? Click here to add more.*
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.

```
{
    "critterId": "",
    "name": "",
    "type": "",
    "images": [""],
    "framerate": 10,
    "frames": {[1,1,97,114,0,8,106],...},
    "animations:{...}
}
```

### 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

### 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

```
{
  "images": [...],
  "framerate": 24,
  "frames": [...],
  "animations": {...}
}
```

### images

this is the path to the texture file of the symbols

### 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

```
{
 "images": [...],
 "framerate": 20,
 "frames": [...],
 "animations": {...}
}

```

### images

this is the path to the texture file of the symbols

### 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

```
{
   "version": 2,
   "build":"itemsId",
   "frames": [...],
   "items" :{...}
}
```

### frames

this denotes the positions of the frames in the texture file

### items

```
"itemId": {
 "front": [...],
 "back":[...]
}

```

#### front

frames that appear when in front of the critter.

#### back (optional)

frames that appear when behind the critter.

## Rooms

```
{
	"RoomId": "",
	"Name": "",
	"Background" "",
	"Foreground": "",
	"SpriteSheet": {
		"images":"",
		"framerate":"",
		"frames":[[...]],
		"animations":{},
		"texturepacker": []
	},
	"Layout": {
		"Background": [...],
		"Foreground": [...],
		"Playground": [...]
	},
	"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]