Modding:Movie theater data

← Index

Work in progress.

This page explains how the files associated with the Movie Theater, what each of them do, and how they are formatted. This is an advanced guide for mod developers.

Movie data

Data\Movies.xnb contains the data for all movies, including their names, descriptions, genre tags, scenes, and dialogue and narration spoken within the film. For reference, below is the raw data of "The Brave Little Sapling":

Data

{ "spring_movie_0": { "ID": null, "SheetIndex": 0, "Title": "The Brave Little Sapling", "Description": "An animated family comedy about a little sprout on a magical adventure to become a tree!", "Tags": [ "family", "comedy" ], "Scenes": [ { "Image": 0, "Music": "sweet", "Sound": "", "MessageDelay": 1000, "Script": "", "Text": "The Brave Little Sapling", "Shake": false, "ResponsePoint": null, "ID": "spring0_0" }, { "Image": 1, "Music": "", "Sound": "", "MessageDelay": 500, "Script": "", "Text": "The brave little sapling is leaving his home. He hesitates for a moment and turns around, knowing he won't be back for a long time...", "Shake": false, "ResponsePoint": null, "ID": "spring0_1" }, { "Image": 6, "Music": "", "Sound": "", "MessageDelay": 500, "Script": "/playSound dustMeep/pause 200/playSound dustMeep/pause 300/playSound dustMeep/pause 100/playSound dustMeep/pause 200/playSound dustMeep", "Text": "The other saplings of his grove are gathered at the edge of town, excitedly waving their twigs goodbye...!", "Shake": false, "ResponsePoint": "sprout_leave", "ID": "spring0_2" }, { "Image": 2, "Music": "rain", "Sound": "", "MessageDelay": 500, "Script": "", "Text": "Oh no! Out of nowhere, it starts raining...! The little sapling goes into a sprint as thunderclouds loom overhead...", "Shake": false, "ResponsePoint": "", "ID": "spring0_3" }, { "Image": 3, "Music": "", "Sound": "thunder", "MessageDelay": 1000, "Script": "", "Text": "Fearing for his life, and demoralized by the relentless downpour, the brave little sapling begins to lose hope...", "Shake": false, "ResponsePoint": "", "ID": "spring0_4" }, { "Image": 4, "Music": "echos", "Sound": "", "MessageDelay": 500, "Script": "", "Text": "...But what's this...? The sapling feels a tingling on the top of his head... ", "Shake": false, "ResponsePoint": null, "ID": "spring0_5" }, { "Image": 5, "Music": "", "Sound": "", "MessageDelay": 500, "Script": "/playSound coin/pause 1000/message \"Perhaps a little rain was what it needed to begin its journey into becoming a tree!\"", "Text": "", "Shake": false, "ResponsePoint": "", "ID": "spring0_6" }, { "Image": 7, "Music": "", "Sound": "", "MessageDelay": 2000, "Script": "", "Text": "Farewell, little buddy!", "Shake": false, "ResponsePoint": null, "ID": "spring0_7" } ] }, ... }

Format

Each movie's specific entry begins with an identifier of the form <season>_movie_<number>, where <season> is the season in which it will be screened, and <number> is either 0 or 1. The movie theater will alternate between screening the #0 movie and #1 movie in the given season each year.

The main block of movie data contains the following:

key format	description
ID	Always null. Purpose unknown.
SheetIndex	Determines where the game looks for the movie's scene sprites within LooseSprites\Movies.xnb.
Title	The title of the film.
Description	The description of the film, seen when interacting with its poster outside of the theater.
Tags	A list of genres that apply to the movie, used to calculate an NPC's reaction to a movie. Can be any arbitrary string; the ones currently used in the game are: family, comedy, horror, art, action, sci-fi, classic, romance, and documentary.
Scenes	A list of data blocks for the film's scenes. (See below.)

Scenes

The Scenes is a list of blocks, each corresponding to a specific scene in the movie. The blocks are listed in chronological order, and the data of each one is as follows:

key format	description
Image	Which image to show within the sequence of the movie's sprites in LooseSprites\Movies.xnb.
Music	The music track to play during the scene. Can be left blank.
Sound	The sound effect to play during the scene. Can be left blank.
MessageDelay	How long to hold the scene before displaying any text.
Script	Used for special visual/auditory effects. Written in the same format as Modding:Event_data#Event_scripts.
Text	The dialogue/narration of the scene.
Shake	A boolean value which, if true, adds screen-shake.
ResponsePoint	If specified, an NPC's reaction data can reference the scene by this name in order to have a specific, timed reaction to it.
ID	An ID for the scene in the format of <season><number>_<index>. <season> and <number> are identical to those values in the ID of the movie itself. <index> is, counting from 0, what number scene this is in the movie.

Movie reactions

Data\MoviesReactions.xnb contains every NPC's taste in movies and their dialogue in response to them. For reference, below is the raw data for Penny's reactions:

Data

[ { "NPCName": "Penny", "Reactions": [ { "Tag": "*", "Response": "love", "Whitelist": [ "Pam" ], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Watching a movie with mom sure brings me back!" }, "DuringMovie": { "ResponsePoint": null, "Script": "/message \"(Pam and Penny are watching intently!)\"", "Text": "" }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "It's great to be able to do things as a family again!" } }, "ID": "reaction_0" }, { "Tag": "spring_movie_0", "Response": "love", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "I'm looking forward to this! Jas and Vincent have been talking about it non-stop." }, "DuringMovie": { "ResponsePoint": "sprout_leave", "Script": "/shake Penny 3000/pause 500/message \"Penny seems to be holding back some tears...\"", "Text": "Wow, it must be really hard leaving his family like that...$s" }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "Thanks for taking me to this, I can't wait to tell the kids how good it was!" } }, "ID": "reaction_1" }, { "Tag": "spring_movie_0", "Response": "love", "Whitelist": [], "SpecialResponses": null, "ID": "reaction_2" }, { "Tag": "family", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Oh, '{0}'! This looks wholesome and fun!" }, "DuringMovie": { "ResponsePoint": null, "Script": "/message \"(Penny is smiling)\"", "Text": "" }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "I should totally bring the kids to see this sometime!" } }, "ID": "reaction_3" }, { "Tag": "comedy", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "I'm excited, I'm in the mood for a good laugh!" }, "DuringMovie": { "ResponsePoint": null, "Script": "", "Text": "Did they just...?! Hahahaha!" }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "Whew, I've got a cramp from all that laughing...!" } }, "ID": "reaction_4" }, { "Tag": "horror", "Response": "dislike", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "I'm a little nervous... I don't usually watch scary movies.$s" }, "DuringMovie": { "ResponsePoint": null, "Script": "/shake Penny 3000/pause 500/emote Penny 28", "Text": "I can't look...$s" }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "I hope I don't have nightmares tonight!$s" } }, "ID": "reaction_5" }, { "Tag": "love", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Oooh, I've been dying to see this!" }, "DuringMovie": null, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "Amazing! I hope they make another one!" } }, "ID": "reaction_6" }, { "Tag": "like", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Hey, I've heard some good things about this one!" }, "DuringMovie": null, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "That was great! Thanks for seeing this with me!" } }, "ID": "reaction_7" }, { "Tag": "dislike", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "I can't say I would've picked this one myself, but I'll try to keep an open mind..." }, "DuringMovie": { "ResponsePoint": null, "Script": "", "Text": "..." }, "AfterMovie": { "ResponsePoint": null, "Script": "", "Text": "Sorry if I ruined the movie for you, it just wasn't really my favorite..." } }, "ID": "reaction_8" }, { "Tag": "seen_love", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Ooh, '{0}'! I saw this one with {2}!" }, "DuringMovie": null, "AfterMovie": null }, "ID": "reaction_9" }, { "Tag": "seen_like", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "I saw this with {2}, it was pretty good!" }, "DuringMovie": null, "AfterMovie": null }, "ID": "reaction_10" }, { "Tag": "seen_dislike", "Response": "like", "Whitelist": [], "SpecialResponses": { "BeforeMovie": { "ResponsePoint": null, "Script": "", "Text": "Hmm, I think {2} took me to see this..." }, "DuringMovie": null, "AfterMovie": null }, "ID": "reaction_11" } ] }, ... ]

Format

Each block of data within the file begins with an NPCName key, which is the name of the NPC to whom the rest of the data in the block will apply. This is followed by a list with the key Reactions. Each block within this list is the data for an NPC's response to a specific type of movie.

If multiple response blocks are applicable to the movie, the game uses the first non-null Response, BeforeMovie, DuringMovie, and AfterMovie fields it can find. Said fields do not necessarily have to come from the same response block. If the game cannot find applicable BeforeMovie, DuringMovie, or AfterMovie fields, it will use default text from HERE.

The data within each block is formatted as follows:

key format	description
Tag	Which category of movie this response is for. In decreasing order of specificity, this can be: *, in which case the response will always be applicable, unless there are other restrictions applied by Whitelist a genre of movie, as listed in the Tags field of a film's data the NPC's reaction to a movie, one of love, like, or dislike. Can be prefixed with seen_, in which case the reaction will only apply if the NPC has seen the film before. or, a specific movie's identifier, as listed at the header of its block. (i.e. spring_movie_0 for "The Brave Little Sapling")
Response	One of love, like, or dislike. Used to calculate Friendship points gained with the NPC. A loved movie earns 200 Friendship points with the NPC, a liked movie earns 100 Friendship points, and a disliked movie neither earns nor costs friendship points with the NPC.
Whitelist	A list of NPC names. If not empty, the response will only trigger if one of the listed NPCs is also present within the theater. Currently only used for Penny, who has a special reaction to watching a movie if her mother Pam is present.
SpecialResponses	Contains the dialogue spoken by an NPC during the film in a series of blocks. (See below.) Can be left null.
ID	A unique identifier in the form of reaction_<index>, where <index> is, counting from 0, what number block this is within the Reactions list.

Special responses

Each SpecialResponses block contains 3 blocks, beginning with BeforeMovie, DuringMovie, and AfterMovie, in that order. Any of these blocks may be left null. By default, the dialogue within these blocks triggers before the film begins, at a random point during it, and after it's finished, respectively. The data within each block is as follows:

key format	description
ResponsePoint	If not null, this dialogue will trigger at the given response point instead of its regular timing. See Modding:Movie_theater_data#Scenes for an explanation of response points.
Script	A script which runs prior to Text being displayed. Written in the same format as Modding:Event_data#Event_scripts.
Text	The dialogue spoken by the NPC.