Creating an Expansion - Prism-99/FarmExpansion GitHub Wiki

An auto-mapped expansion does not specify details of where it is to be mapped, it just provides details on how it is to be mapped in.

Map

The map itself can be any TMX map using the standard Stardew Valley layout. The map is required to have an exit of each of the 4 sides of the map. The exit should be 2 or 3 tiles wide. The exits can be anywhere on the edge of map. An expansion map uses Map Tokens to identify the entrances and other details of an expansion.

Artwork

Filename Size (px) Details
for_sale.png 300x200 To be displayed on the For Sale sign when the land goes for sale. The image name must be the same as the 'ForSaleImageName' in the expansion.json file.
WorldMap.png 20x13 Used in the world map view, when the Player presses 'M'. The image must be named 'WorldMap.png'.
thumbnail.png 150x150 Image provided via the SDR API to other mods that request a thumbnail of the expansion.

Expansion Info

In the expansion.json file you also specify some meta data about the mod: 

     "LocationName": "FarmExpansion",
     "DisplayName": "Classic Farm",
     "Description": "Classic map to that was part of the original version.",
     "Cost": 0,
     "Requirements": "",
     "LocationDefinition": "-1/-1/-1/-1/708 -1/708 -1/-1/-1/382 .05 770 .1 390 .25 330 1",
     "SeasonOverride":""
  • LocationName - a unique name that will be used internally to reference your expansion
  • DisplayName - the name to be displayed by SDR aware mods
  • Description - a description of the land that will be shown on the For Sale board
  • Cost - how many gold pieces purchase the expansion
  • Requirements - any requirements the player must meet before the expansion is available (see Condition Flags for details)
  • LocationDefinition - this defines the Foraging, Artifact and fish details (see [Modding](https://stardewvalleywiki.com/Modding:Location_data) for details)
  • SeasonOverride - specify a permanent season for your expansion (spring, summer, fall, winter)
You can also specify an email to be sent to the player upon purchase of your expansion. 
  "MailId": "fe.classic.purchase",
  "MailContent": "Congratulations @,^^You have purchased the 'Classic Farm' parcel of land to the West of your current Farm.^^Signed^Dewey, Cheatem, and Howe^Attorney at law[#]Land Purchase",
⚠️ **GitHub.com Fallback** ⚠️