Game resources and catalogs

Most spawn and change calls take one of the game’s own names: Horse.spawn a breed, player.giveItem an item class, Vfx.spawn a particle effect. The pages in this group list every name the mod ships for each of them, so you can pick one without starting a server.

Note

These are the game’s data catalogs, not the script resources your server loads. For those, see Resources and the manifest.

Most catalogs can also be read at runtime, and the runtime list always wins over these pages:

src/server/index.ts

const lists: Record<string, (filter?: string) => string[]> = {
  breeds: () => Horse.breeds(),
  gear: () => Horse.gearPresets(),
  roles: () => Npc.roles(),
  blips: () => Blip.types(),
  effects: (prefix) => Vfx.list(prefix),
};

Events.on("playerCommand", (player, command, args) => {
  if (command !== "catalog") return;
  const names = lists[args[0] ?? ""]?.(args[1]) ?? [];
  Chat.sendToPlayer(player, names.slice(0, 20).join(", ") || "Try /catalog breeds");
});

The catalogs

Catalog	Entries	Page
Faces	212 male, 61 female	Faces, hair and skins
Hairstyles	262 male, 71 female	Faces, hair and skins
Skins	47 male, 41 female	Faces, hair and skins
Beards	51, male only	Beards
Horse breeds	58	Horse breeds
Horse gear	535 items, 224 presets	Horse gear
NPC roles and souls	10 roles, 1,040 looks	NPC and dog souls
Dog souls	156	NPC and dog souls
Item classes	5,604	Items
Status effects	929	Buffs
Particle effects	588	Particle effects
Marker materials	267	Marker materials
Blip icons	83	Blip icons
Hand props and emotes	408 props, 6 emotes	Hand props and emotes

Where to read each one at runtime

Catalog	Server call	Used by
Faces, hair, skins, beards	Appearances.options, Appearances.beards	player.setAppearance, npc.setAppearance, Npc.create({ appearance })
Horse breeds	Horse.breeds	Horse.spawn
Horse gear	Horse.gearItems, Horse.gearPresets	horse.setGear, horse.equipGear, Horse.spawn
NPC roles	Npc.roles	Npc.create({ soul })
Souls, items	None: a call returns false or throws for a name it does not know	Npc.create, Dog.spawn, player.giveItem, player.takeItem, GroundItem.spawn
Buffs	Buffs.find, Buffs.classes, Buffs.tags	player.addBuff, player.clearBuffs, Buffs.claim
Particle effects	Vfx.list	Vfx.spawn
Marker materials	Marker.list	Marker.place
Blip icons	Blip.types	Blip.create({ type })
Animations and hand props	Animations.list, Animations.props	player.playAnimation, npc.playAnimation

The lists on these pages are generated from the mod’s own tables for the release the guides are checked against. When a name listed here is refused at runtime, your server runs a different build: trust the runtime.