Modding:Festival data
← Index
This page explains how the game stores and uses festival data. This is an advanced guide for mod developers.
Overview
Festivals are complex events with both content and code components. The festival data files are named for the date they occur on, and include when and where the festival occurs, as well as character dialog, cutscenes, and other information. For the majority of festivals, there exist special map files with location data for villager placements. These are located within Content/Maps like other map files. For scripted events that play during the festival (such as Lewis judging the farmer's grange display), the event is usually handled in code.
Data Keys
| entry | explanation |
|---|---|
| name | The name of the event. Used to tell the player when the festival is ready. |
| conditions | When and where the festival takes place. Format is <location>/<start time> <end time>.
|
| shop | The items the festival shop sells. See Shop Format for more information. |
| set-up | The event data that is run when the player first enters the festival. This includes moving the player to the festival map. |
<string npcName>
|
The default event dialog for that npc. |
<string npcName>_spouse
|
The event dialog for that npc when they are married to the player. |
Any other entry is event data for a cutscene that is used during the event. In some cases, like the luau, these are linked together when played in the game.
Shop Format
Shop data for festivals is stored as a space-separated list. Each group of four values is one entry for the shop. The meanings of each value are explained here:
| allowed values | explanation |
|---|---|
|
Item type. Boots, Blueprint, BigBlueprint, BigObject, Furniture, Hat, Object, Ring, or Weapon, accordingly. |
<int id>
|
Item ID. |
<int cost>
|
Cost in shop. (For seeds, this is modified based on profit margin.) |
<int amount>
|
How many of that item is available from the shop, or -1 for unlimited. |
Night Market
The Night Market is a special festival, as it is handled differently than other festivals. While there are separate Night Market maps, the NPC data does not exist on these. Instead, NPCs dynamically enter and leave the festival via schedule data. The raw data for the schedule destinations of each NPC during the Night Market can be found below.
Raw Data
| Data |
|---|
{
Winter 15:
Abigail: Beach 30 34
Shane: Beach 20 24
Penny: Beach 35 36
Linus: Beach 19 4
Leah: Beach 41 35
Jas: Beach 19 24
Harvey: Beach 37 31
Emily: Beach 25 36
Clint: Beach 37 33
Winter 16:
Vincent: Beach 19 24
Sebastian: Beach 10 39
Robin: Beach 13 31
Maru: Beach 11 33
Marnie: Beach 37 31
Lewis: Beach 40 34
Haley: Beach 27 34
Demetrius: Beach 11 32
Caroline: Beach 24 32
Winter 17:
Sam: Beach 11 34
Jodi: Beach 20 24
George: Beach 11 39
Evelyn: Beach 12 39
Elliot: Beach 38 36
Alex: Beach 27 24
}
|