Home - Prism-99/FarmExpansion GitHub Wiki

Table of Contents Welcome File structure Auto Mapping Grid Layout Auto Map Requirements How It Works Farm Expansion Warp Network Adding An Expansion

Welcome to the Stardew Realty wiki!

Stardew Realty is a continuation of the original FarmExpansion mod from AdvizeGH. I have continued the original author's vision and matured the mod from a single hard coded expansion to a framework supporting content packs with farm maps that can be used as additional farming land. A new sign board is added to the Town map on the path from the Bus Stop. The sign displays up to 2 parcels of land that are currently for sale. If the Player wants, they can purchase 1 or both of the lands. The Player is then informed that they will receive a letter the next with their deed and the land is then available. When a content packs perquisites are met and the selling price is not free, the Player is sent a HUD message the morning the land goes for sale.

The expansion farm supports:

• Barns
• Coops
• Shed
• Silo
• Junimo Huts
• Animals
• Ponds
• all vanilla animals
• Supports BFAV animals

Expansion packs are author definable:

• when the land can be sold
• how much the land costs
• the land's world map location
• thumbnails for the world map and for sale ad
• patching to be done to the target map
• warps to and from the new land

Land can be given to the Player after the requirements are met or the land can be put on sale when the requirements are met.

Land can be available:

• after X number of game days for price Y
• the Player reaches skill level X for skill Y
• the Player marries an NPC and family land is added to the Farmer's land
• complete Quest X and the land can be given or sold to the Player
• All defined flags

Mod Folder 
      |----- manifest.json
      |----- expansion.json
      |----- assets
               |----- map.tmx
               |----- mini_map.png
               |----- world_map.png

• manifest.json - standard SMAPI content pack manifest file.
• expansion.json - configuration file format.
• assets folder
  • map.tmx- standard TMX map file used for Stardew Valley mapping
  • mini_map.png - a thumbnail image of the land that is displayed on the For Sale sign board in Town.
  • world_map.png - the image to be merged into the Stardew world map

In order to make adding a new Farm less difficult, the SDR framework has a grid of locations that Expansion Farms can be auto mapped into without the mod author needing to deal with all the fun of trying to integrate their Farm into the game.

Currently the grid is a 3x3 box with a single additional location at the top right of the grid layout.

7	4	1	0
8	5	2
9	6	3

The top right piece of land is the first grid location to be filled. Additional Farms are mapped into the grid from top to bottom, right to left.

Auto mapping only has 1 basic requirement:

• the Farm map needs to have an exit path on each of the map sides

An expansion map requires Map Tokens to identify the entrances to the expansion.

Note: A strongly suggested optional requirement is a Cave Entrance, to be used in the Farm Expansion Warp Network.

In the expansion.json file the mod author provides the coordinates of the 4 entrances and SDR uses those values to patch in path blocks when the Farm has not been activated. When the Farm is activated, SDR removes the path blocks to Farms beside the new map and warps are added to the neighbours of the new Farm.

As the player's Farm network can be very big SDR provides a warp network to move the Player between Expansion Farms. If the expansion.json file specifies Cave Entrance point, SDR will add the coordinates supplied to the list of warp locations given to the User in the Farm Expansion Warp Room.

Creating an Expansion