Modding:Maps

From Stardew Valley Wiki
Jump to navigation Jump to search

Index

This page explains how to edit maps. This is an advanced guide for modders.

Intro

Basic concepts

  • A map is the layout of the terrain (like water, cliffs, and land), terrain features (like bushes), buildings, paths, and triggers for a particular area. When you reach the edge of an area or enter a building, and the screen fades to black during the transition, you're moving between maps.
  • Each map consists of several layers stacked one in front of the other. Objects in a layer closer to the front will hide objects in layers behind them. From back to front, the standard layers are...
    layer name typical contents
    Back Terrain, water, and basic features (like permanent paths).
    Buildings Placeholders for buildings (like the farmhouse). Any tiles placed on this layer will act like a wall unless the tile property has a "Passable" "T".
    Paths Flooring, paths, grass, and debris (like stones, weeds, and stumps from the 'paths' tilesheet) which can be removed by the player.
    Front Objects that are drawn on top of things behind them, like most trees. These objects will be drawn on top of the player if the player is North of them but behind the player if the player is south of them.
    AlwaysFront Objects that are always drawn on top of other layers as well as the player. This is typically used for foreground effects like foliage cover.
  • MapLayers.png

  • (Using Tiled) There are 2 different types of layers along with the 5 main layers, Objects Layer (cloud-like icon) and Tile Layer (grid icon). The Tile Layer is where you make map edits (placing and removing tiles) and the Objects Layers is where you add and edit tile data. Your layers must match the ones above. Note that depending on the map, they may be missing a Paths or AlwaysFront layer
  • Each layer consists of many tiles, which are 16×16 pixel squares placed in a grid to form the visible map. Each tile can have properties (e.g. passable / blocked), special logic (e.g. an action to perform when the player steps on them), and a picture to show. The picture is represented by a sprite index (or tile index), which is its position in an associated spritesheet (see next).
  • Each map has one or more spritesheets (also known as tilesheets when talking about mods), which contains the available tiles and images that are put together to form the visible map.

Tile coordinates

Each tile has an (x, y) coordinate which represents its position on the map, where (0, 0) is the top-left tile. The x value increases towards the right, and y increases downwards. For example:

Modding - creating an XNB mod - tile coordinates.png

Map formats

There are two map formats used in Stardew Valley modding: .tmx (from the Tiled map editor) and .tbin (from the now-deprecated tIDE map editor). The features supported by both formats are almost identical, but there are a few differences:

feature .tmx .tbin
format ✓ XML (basically text) ✘ binary
edit in Tiled ✓ supported ✓ supported with plugin
edit directly ✓ can open in a text editor ✘ not supported
tile flip ✓ supported ✘ not supported
tile rotation ✓ supported ✘ not supported
source control ✓ efficient storage, can diff changes ✘ inefficient storage (need to copy entire file with each commit), can't diff changes

.tmx is recommended per the above, but both formats are fine to use, and you can convert between them in Tiled by clicking File > Export As.

Getting started

There are two main ways to edit a map.

Using SMAPI

Creating a SMAPI mod requires programming, but it's much more powerful and multiple SMAPI mods can edit the same map. If you want to use this approach:

  1. Create a SMAPI mod.
  2. See Making changes with SMAPI below.

The rest of this guide assumes you're using Tiled, but many of the concepts are transferrable and you can use both Tiled and SMAPI (e.g. create/edit maps in Tiled and load/edit them in SMAPI).

Using Tiled

Tiled is a popular map editor that can be used to edit Stardew Valley maps, no programming needed. You need to unpack the map's XNB, edit the map, and make a Content Patcher or SMAPI mod to load your map. If you want to use this approach:

  1. Install the latest version of Tiled.
  2. Once installed, at the top left, go to Edit > Preferences > Plugins and enable the tbin plugin (tbin.dll on Windows, libtbin.so on Linux, or libtbin.dylib on Mac).
  3. Set the following settings:
    setting value reason
    View > Snapping > Snap to Grid ✓ enabled This is required to convert objects back into the game's format.
    View > Highlight Current Layer ✓ enabled This makes it more clear which tile you're editing.
  4. See Modding:Editing XNB files for help unpacking & packing the map files.
  5. See instructions below for map changes.

(If you use xnbcli to unpack the original game maps, you'll need the .tbin plugin even if you plan to use .tmx since xnbcli still produces .tbin files.)

Map edits

Editing maps

Important note: when making custom maps, always start with a vanilla map and edit it. Don't try to create a new map in Tiled; the game needs certain tiles, map properties, etc to be present.

  1. Unpack the game's Content/Maps folder and create a copy to edit your maps in. Use this copy of the folder to edit any maps in before moving them to your mod release folder.
  2. Use the same method to unpack the map you want to edit if it is not a vanilla one, then place the map in your editing folder.
  3. Open the .tbin or .tmx file via Tiled. Note: make sure the file is in the same folder as the unpacked tilesheets!
  4. Make your changes.
  5. Save the file. Don't use Save as, as it can corrupt the map.
  6. Move the .tbin or .tmx file, and any custom tilesheets it needs, to your mod release folder. Place them in the assets folder.
  7. Load your map via SMAPI or Content Patcher (or another framework mod).

Custom map

You can add a new map and location to the game. The easiest option is to create the map using Tiled, then use Content Patcher to add the custom location to the game. After loading your save, you can use this console command to jump to the map: debug warp YourLocationName X Y.

Note that the map must be built in a certain pattern; look at the maps in the Content/Maps folder for examples. It's often easier to start from an existing map and modify it, instead of starting from scratch.

Using Content Patcher to add custom locations is strongly recommended.
You can add new locations in C# yourself, but be aware of factors like object persistence and NPC pathfinding that are easy to get wrong. If you really want to do it yourself, use the specialized LoadStageChanged event to add the location to Game1.locations during the CreatedInitialLocations or SaveAddedLocations stage.

Custom tilesheet

You can add custom sprites, tiles, or images to a map. Be sure to prefix custom tilesheet IDs with z_ to avoid shifting the vanilla tilesheet indexes.

  1. Create your spritesheet and place it in the same folder as your .tbin or .tmx map file. This should be a PNG image with images divided into 16x16 tiles (see Modding:Editing XNB files#Intro for examples).
  2. Open the map in Tiled.
  3. Add the custom spritesheet:
    1. In the Tilesets pane, click the Modding - creating an XNB mod - Tiled 'new tilesheet' button.png button.
    2. Give it a descriptive name (like 'cute bugs') and choose the image source.
    3. Make sure that Embed in map is checked.
    4. Keep the defaults for the other settings and click OK.
  4. Add custom sprites to the map:
    1. In the Layers pane, click the layer you want to edit.
    2. In the Tilesets pane, click the tab for your custom spritesheet.
    3. In the Tilesets pane, click one tile to select it. To choose multiple, click and drag the cursor.
    4. Move the cursor to the map, and you'll see an overlay with the tiles you selected.
    5. Click the map to place those tiles on the selected layer.

Map properties

Each map can have multiple map properties, which define attributes and behaviour associated with the map like lighting, music, warp points, etc. Each property has a name (which defines the type of property), type (always 'string' in Stardew Valley), and value (which configures the property). See known properties below.

In Tiled:

  1. Click Map on the toolbar and choose Map Properties.
  2. View and edit properties using the GUI.

Tile properties

Tile properties are set on individual map tiles. They can change game behaviour (like whether the player can cross them), or perform actions when the player steps on or clicks the tile. Each property has a name, type (always 'string' in Stardew Valley), and value. In Tiled these are represented by two types: object properties only apply to the selected tile, while tile properties apply to every instance of that tile. In general you'll always set object properties, so we'll only cover those.

To view tile properties:

  1. Select the object layer in the Layers pane.
  2. Choose the Modding - creating an XNB mod - Tiled 'select object' button.png select object tool in the toolbar.
  3. Click the object whose properties you want to view. Objects are represented with a gray selection box on the map:
    Modding - creating an XNB mod - map object.png
  4. The object properties will be shown in the Properties pane.
    Modding - creating an XNB mod - Tiled tile properties pane.png

To edit properties for an existing object:

  • Change a value: click the value field and enter the new value.
  • Change a name: select the property and click the Modding - creating an XNB mod - Tiled 'edit' button.png icon.
  • Add a property: click the Modding - creating an XNB mod - Tiled 'add' button.png icon, enter the property name, make sure the selected type is "string", and click OK.

To add a new object:

  1. Select the object layer in the Layers pane.
    There should be one object layer for each tile layer. If the object layer is missing, create one with the same name as the right tile layer.
  2. Choose the Modding - creating an XNB mod - Tiled 'insert rectangle' button.png insert rectangle tool from the toolbar.
  3. Click and drag the rectangle over the tile you want to edit . Make sure it snaps to the tile grid (see #Using Tiled), and only one tile is selected.
  4. Change its Name field to TileData.
  5. See previous for how to edit its properties.

Tiles

You can edit the tiles for an existing map. See the Tiled documentation for more info.

Tile animation

Modding - creating an XNB mod - example animation.gif

You can animate tiles to create effects like Gil in his rocking chair (see example at right).

In Tiled:

  1. Click the edit button (wrench icon) for the tilesheet in the Tilesets pane.
  2. Select the tile you want to animate in the new view.
  3. Click Tileset > Tile Animation Editor in the toolbar to show that window.
  4. In the new window, drag tiles from the tilesheet into the box on the left to create a frame (one image in the sequence). If you need to delete frames, select the frame(s) and press Backspace/Delete(Windows) or fn + Backspace(Apple)
  5. Double-click the numbers to change how long each frame stays on the screen before the next one (in milliseconds). Make sure every frame has the same time; the game can't handle variable frame times. For example, here's the animation editor showing one of the tiles of Gil rocking:
    Modding - creating an XNB mod - Tiled example animation pane.gif
  6. When you're done, close the pane.
  7. The animated tiles in the Tilesets pane will now have a little symbol in the bottom-right corner:
    Modding - creating an XNB mod - Tiled example animation tileset.png
    The animation is now part of that tile. Every instance of that tile on the map will now have the same animation.

Tile flip/rotation

An example tile rotated four ways, below the Tiled flip/rotate buttons.

You can rotate and flip tiles without needing to create rotated/flipped versions of the tilesheet. This needs SMAPI 3.4 or later to be installed; the base game doesn't recognize tile transforms.

In Tiled:

  1. With the stamp tool selected, click the tile in the tilesheet you want to use.
  2. Click the flip or rotate buttons (see image at right).
  3. Click the map to place the flipped/rotated tile.
This only works with .tmx map files.
Tile transforms aren't supported by the .tbin plugin. See map formats for more info.

Known properties

Map properties

Known map properties:¹

property explanation
AmbientLight <byte r> <byte g> <byte b>
(valid in indoor locations and locations that ignore outdoor lighting)
Sets the RGB colour that is subtracted from white (255,255,255) in order to create the ambient light.
Example: AmbientLight 95 95 95 for a normal indoor daytime lighting.
BackwoodsEntry [<int x> <int y>]
(valid in farm)
The position the player is warped to when entering the farm from the Backwoods.
BrookSounds [<int x> <int y> <int type>]
(valid in outdoor locations)
Adds sound sources. The <x> <y> fields are the tile coordinates, and <type> is the ambient sound ID. The <type> of sound can be one of...
  • 0 (babblingBrook);
  • 1 (cracklingFire);
  • 2 (engine);
  • 3 (cricket).
BusStopEntry [<int x> <int y>]
(valid in farm)
The position the player is warped to when entering the farm from the Bus Stop.
CanCaskHere T²
(valid in any location)
Allows casks to work in that location.
DayTiles [<string layerName> <int x> <int y> <int tilesheetIndex>]+
(valid in any location)
Sets tiles to appear between 6AM to 7PM. Anytime before 7pm, this finds the tile at position (<x>, <y>) on the map layer matching <layerName>, changes its tilesheet index to the specified <tilesheetIndex>, and adds a glow to simulate daylight. The glow will only be added if the location is indoors and the <tilesheetIndex> is 256, 288, 405, 469, or 1224. The parameters can be repeated to affect multiple tiles.
Example: DayTiles Front 3 1 256 Front 3 2 288.
Doors [<int x> <int y> <string sheetID> <int tileID>]+
(valid in indoor locations)
Adds functionality to interior doors. Used with Action Door tile properties. The <x> <y> fields are the tile coordinates, <sheetID> is the name of the sheet containing the door sprite, and <tileID> is the tile index in the spritesheet.
Fall_Objects T²
Spring_Objects T²
Summer_Objects T²
Winter_Objects T²
Whether to spawn seasonal objects on spawnable tiles based on the data in Data\Locations.xnb.
Example: Fall_Objects.
FarmCaveEntry [<int x> <int y>]
(valid in farm)
The position the player is warped to when entering the farm from the farm cave.
FarmHouseEntry [<int x> <int y>]
(valid in farm)
Changes the position of the Farm House. Corresponds to the front door, or the position the player will be warped to when leaving the house.
Feed <int x> <int y>
(valid in coops and barns)
Sets the spawn location of the Hay Hopper in a coop or barn.
Example: Feed 3 2.
forceLoadPathLayerLights T²
(valid in outdoor non-festival locations)
Whether to load lights from the Paths layer on maps where they would not normally be.
Example: forceLoadPathLayerLights true.
ForceSpawnForageables T²
(valid in indoor locations)
Enables forage items spawning in that location.
ForestEntry [<int x> <int y>]
(valid in farm)
The position the player is warped to when entering the farm from the Cindersap Forest.
GrandpaShrineLocation [<int x> <int y>]
(valid in farm)
The position of grandpa's shrine. Corresponds to the upper left corner.
GreenhouseLocation [<int x> <int y>]
(valid in farm)
The default position of the greenhouse. Corresponds to the upper left corner of the greenhouse's foundation.
IgnoreLightingTiles T²
(valid in indoor locations)
Whether to ignore lights on the Front and Buildings layers.
Example: IgnoreLightingTiles true.
indoorWater T²
(valid in indoor locations)
Enables water logic (ie. fishing, etc.) in that location.
KitchenStandingLocation [<int x> <int y>]
(valid in farmhouse)
The position the player's spouse will stand when using the kitchen.
Light [<int x> <int y> <int type>]+
(valid in any location)
Adds light sources. The <type> field is the kind of light source (e.g. 4 for twin candles), and <x> <y> are the tile coordinates.The <type> of light source can be one of...
  • 1 (lantern);
  • 2 (window);
  • 4 (sconce);
  • 5 (cauldron);
  • 6 (indoor window);
  • 7 (projector).

Any other value will crash the game.
Example: Light 3 8 4 6 8 4 11 8 4 3 2 5 10 2 5 6 19 5 5 15 5 5 11 5 11 12 5 (Adventurer's Guild).

LocationContext Default
(valid in any location)
Sets the map to be part of the mainland for game logic purposes, like weather.
LocationContext Island
(valid in any location)
Sets the map to be part of Ginger Island for game logic purposes, like weather.
MailboxLocation [<int x> <int y>]
(valid in farm)
The position of the player's mailbox. Corresponds to the upper left corner.
Music <string name>
(valid in any location)
Sets the music that plays when the player enters, where <name> is the cue name in the audio files.
Example: Music MarlonsTheme.
Music <int start> <int end> <string name>
(valid in any location)
Sets the music that plays when the player enters, where <name> is the cue name in the audio files, music will only play if the time is between <int start> (inclusive) and <int end> (exclusive).
Example: Music 800 1200 MarlonsTheme.
NightTiles [<string layerName> <int x> <int y> <int tilesheetIndex>]+
(valid in any location)
Changes the tile after 7pm. Outside, it works along DayTiles: set a DayTiles tile for the map to load between 6am to 7pm, then a NightTiles to load between 7pm to the end of the day. It is mostly used for lamps in the game.
NPCWarp [<int fromX> <int fromY> <string toArea> <int toX> <int toY>]+
(valid in any location)
Equivalent to Warp, but only usable by npcs.
Outdoors T²
(valid in any location)
Sets whether the location is outdoors.
Example: Outdoors true.
ProduceArea <int x> <int y> <int width> <int height>
(valid in coops and barns)
Sets the area where animals can spawn within a coop or barn.
Example: ProduceArea 6 4 8 7.
ScreenshotRegion <int left> <int top> <int right> <int bottom>
(valid in any location)
Constrains the portion of the map rendered when screenshots are taken.
Example: ScreenshotRegion 0 27 69 61.
SeasonOverride [<string season>]
(valid in any location)
Assumes a specific season for most game checks. (If a crop is in season, which tilesheet to use, etc.)
ShippingBinLocation [<int x> <int y>]
(valid in farm)
The position of the default shipping bin. Corresponds to the upper left corner.
skipWeedGrowth T²
(valid in any location)
Prevents weeds from spawning and spreading in this location.
SpouseAreaLocation [<int x> <int y>]
(valid in farm)
The position of the the outdoor spouse area. Corresponds to the upper left corner.
Stumps [<int x> <int y> <unused>]+
(valid in Secret Woods)
Adds stumps to the Secret Woods map daily. The third field for each stump appears to be unused.
Example: Stumps 24 6 3 29 7 3 26 10 3 46 6 3 34 26 3 41 26 3.
TreatAsOutdoors T²
(valid in indoor locations)
The location is treated as outdoors for the purposes of spawning anything other than lights from the Paths layer and yielding Coal from breaking rocks.
Example: TreatAsOutdoors true.
Trees [<int x> <int y> <int type>]+
(valid in any location)
Adds trees to the map. The <x> <y> fields are the tile coordinates, and <type> is the tree type (1: oak, 2: maple, 3: pine, 6: palm, 7: mushroom tree).
Example: Trees 17 18 2 20 31 2.
UniquePortrait [<str name>]+
(valid in any location)
Switches the portraits for the named NPCs to the unique variants for the location. An NPC Jane in location Room will switch to portrait Portraits/Jane_Room.
Example: UniquePortrait Maru.
UniqueSprite [<str name>]+
(valid in any location)
Switches the spritesheets for the named NPCs to the unique variants for the location. An NPC Jane in location Room will switch to spritesheet Characters/Jane_Room.
Example: UniqueSprite Maru.
ViewportFollowPlayer T²
(valid in any location)
Forces the viewport to stay centered on the player.
Example: ViewportFollowPlayer.
Warp [<int fromX> <int fromY> <string toArea> <int toX> <int toY>]+
(valid in any location)
Sets the tiles which warp the player to another map (e.g. doors). The <fromX> <fromY> fields are the tile coordinates that initiate the warp, and <toArea> <toX> <toY> are the name of the in-game location to warp to and the tile coordinates within it.
Example: 6 20 Mountain 76 9.
WarpTotemEntry[<int x> <int y>]
(valid in farm)
The position the player is warped to when teleporting to the farm via Warp Totem or Return Scepter.
WindowLight [<int x> <int y> <int type>]+
(valid in any location)
Adds light sources that are only lit during the day when it is not raining (like the light coming through a window). See Light for details.

The following properties are used but apparently have no effect: Arch, Debris, Spouse, and Fish.

¹ Map properties are primary handled in various methods of the GameLocation class, particularly resetLocalState.
² The T value (short for true) is conventional, but any non-empty value will work too.

Tile properties

Known tile properties (excluding specialised properties like TouchAction WomensLocker):¹

layer property explanation
Back Bed T² If the player stands on this tile, they're considered in bed for the purposes of stamina regen (in multiplayer) and pass-out logic.
Back Buildable T² Allows farm buildings to be placed on this tile if there are no other obstructions.
Back DefaultBedPosition T² Used in the farmhouse for the initial placement of the starting bed.
Back DefaultChildBedPosition T² Used in the upgraded farmhouse for the initial placement of the child beds.
Back Diggable T² Marks the tile as diggable with the hoe and enables planting crops. Also allows grass to spread to this tile.
Back NoFishing T² Prevents the player from casting the line onto this tile when fishing.
Back NoFurniture T² Prevents the player from placing furniture on this tile.
Back NoPath Excludes this tile from NPC pathing, making them go around it if necesssary.
Back NoSpawn All
NoSpawn True
Combines NoSpawn Grass and NoSpawn Tree.
Back NoSpawn Grass Prevents debris (e.g. weeds or stones) from spawning on this tile.
Back NoSpawn Tree Prevents trees from spawning on this tile. Prevents the player from planting trees on this tile, except on the farm. If a tree is already on this tile, prevents it from growing.
Back NoSprinklers T² Prevents sprinklers from being placed on this tile.
Back NPCBarrier T² Prevents NPCs from crossing this tile when used on the Farm (including coops, barns, and slime hutches), UndergroundMine, or the island. Also prevents some spawns on this tile, in those locations.
Back Passable T² Prevents players from walking or placing objects on this tile, even if they'd normally be able to do. (Direct opposite of Buildings Passable T below.) Commonly used on certain water tiles for bordering the sides of bridges, to prevent players from walking off into open water. Can be added as a single TileData object for a specific tile, or (more commonly) to every instance of a tile by editing the tileset and adding it to the tile index.
Back Placeable T² Prevents players from placing objects on this tile.
Back TemporaryBarrier T² Used only briefly when doors open. Marks this tile impassable to a player, while NPCs will treat it as an obstacle to pause before rushing through.
Back Type <str type> Sets the tile type for various game logic (e.g. step sounds or planting crops), where <type> is one of Dirt, Stone, Grass, or Wood.
Back Water T² Marks the tile as a water tile for various game logic (i.e. items splash into it, can refill watering can from it, can possibly fish in it, can possibly place crab pots in it, will water nearby paddy crops, will block most open-tile checks, will regenerate health in it if indoors, and will draw animated overlay over it if outdoors; if in the Mines, Sewer, or Submarine; or otherwise not in the Desert).
Back WaterSource T² Lets the player refill the watering can from this tile.
Buildings NPCPassable T² NPC-only version of Passable below. Allows NPCs to pass through this tile.
Buildings Passable T² Allows passing through a tile, even though Buildings tiles can't normally be walked through. Often used for small footbridges that need to be on Buildings, over water. Direct opposite of Back Passable T above. Can be added as a single TileData object for a specific tile, or (more commonly) to every instance of a tile by editing the tileset and adding it to the tile index.
Buildings Shadow T² Player-only version of Passable above. Allows the player to pass through this tile, but not NPCs.
Paths Order <I> To place on index 29 and 30 of the Paths tilsheet. Set the order the cabins will spawn at the creation of a Multiplayer save.

The TouchAction property makes something happen when the player steps on the tile:

layer property explanation
Back TouchAction Bus Starts the Bus Ride to the Desert mini-cutscene, works in conjunction with Action BusTicket.
Back TouchAction ChangeIntoSwimsuit Changes the player into their swimsuit and disables running.
Back TouchAction ChangeOutOfSwimsuit Changes the player into their regular clothes and enables running.
Back TouchAction DesertBus Lets you ride the bus back to the Bus Stop..
Back TouchAction Emote <string npc> <int emoteID> Finds the NPC whose name matches the <npc> field, and causes them to show the given <emoteID> above their head (4: empty can, 8: question mark, 12: angry, 16: exclamation, 20: heart, 24: sleep, 28: sad, 32: happy, 36: x, 40: pause, 52: videogame, 56: music note, 60: blush).
Back TouchAction FacingDirection <string npc> <int direction> Finds the NPC whose name matches the <npc> field, and make them face the given direction (0: up, 1: right, 2: down, 3: left).
Back TouchAction legendarySword Gives them the Galaxy Sword when holding a Prismatic Shard.
Back TouchAction MagicWarp <string area> <int x> <int y> [string prerequisite] Warps the player to the <x> <y> tile coordinates in the given <area> with a magic sound and effects. If the [prerequisite] field is specified, only occurs if that flag is set via Game1.player.mailReceived.
Back TouchAction PoolEntrance Switches the player between swimming and walking mode.
Back TouchAction Sleep Ends the day if the player confirms.

The Action property makes something happen when the player interacts (e.g. clicks) with the tile:

layer property explanation
Buildings Action AdventureShop Shows the Adventurer's Guild shop screen.
Buildings Action Arcade_Prairie Shows the Journey of the Prairie King arcade game.
Buildings Action Arcade_Minecart Shows the Junimo Kart arcade game.
Buildings Action BuyBackpack Shows a menu which lets the player upgrade their backpack if an upgrade is available.
Buildings Action Billboard Shows the calendar menu.
Buildings Action Blacksmith Opens Clint's shop menu, if Clint is nearby.
Buildings Action BrokenBeachBridge Prompts you to use wood to repair the bridge.
Buildings Action BusTicket Offers to let you go to the Calico Desert if the Bus has been repaired. Works in conjunction with TouchAction Bus.
Buildings Action BuyQiCoins Shows a dialogue which lets the player buy 100 Casino club coins.
Buildings Action Concessions Opens the snack shop in the theater. (Only from inside the theater.)
Buildings Action Carpenter Opens the carpenter menu, if Robin is nearby.
Buildings Action ColaMachine Offers to let the player buy a Joja cola.
Buildings Action ClubCards
Action Blackjack
Shows the casino blackjack minigame.
Buildings Action ClubComputer
Action FarmerFile
Shows a dialogue with play stats (steps taken, gifts given, dirt hoed, etc).
Buildings Action ClubSeller Shows a dialogue which lets the player buy a Statue of Endless Fortune for one million gold.
Buildings Action ClubShop Shows the casino shop menu.
Buildings Action ClubSlots Shows the casino slots minigame.
Buildings Action Dialogue <text> Shows a generic dialogue box with the given text. See dialogue format.
Example: Action Dialogue Hi there @!
Buildings Action DivorceBook Shows divorce options for the player's current marriage status (as if they clicked the divorce book).
Buildings Action Door <npcName> [npcName] Sets up an interior door that cannot be opened unless the player has two or more hearts of friendship with any of the named NPC(s). Placed on the lower of the two door tiles. See dialogue format.
Example: Action Door Abigail
Buildings Action ElliotBook TODO: Explain what this does.
Buildings Action ElliotPiano TODO: Explain what this does.
Buildings Action EnterSewer Warps you to the sewer if you have obtained the key.
Buildings Action EvilShrineLeft Turns your kids into doves for a prismatic shard.
Buildings Action EvilShrineCenter Erases your ex-spouses memory of you.
Buildings Action EvilShrineRight Toggles monster spawning for your farm.
Buildings Action Garbage <ID> Has a chance to give a specific item to the player based on the <ID>. Can only be clicked once per day. TODO: Explain what each <ID> means.
Buildings Action Gunther Opens the museum menu where you can donate artifacts or claim rewards.
Buildings Action HMGTF Gives you "??HMTGF??" when you have a Super Cucumber in your hand.
Buildings Action IceCreamStand If Summer, shows the Ice Cream Stand shopping screen. Otherwise, the player will be told to come back in the summer. (Needs an NPC behind the stand.)
Buildings Action JojaShop Shows the Joja shopping screen.
Buildings Action Jukebox Shows the jukebox menu to choose the ambient music.
Buildings Action kitchen Shows the cooking menu, if you're in the Farmhouse.
Buildings Action Letter <string messageKey> Loads a message with the given key from the Content\Strings\StringsFromMaps.xnb file and displays it on-screen as a letter. Uses the same syntax as Data\mail.xnb.
Buildings Action LockedDoorWarp [<int toX> <int toY> <string toArea> <int openTime> <int closeTime>] Creates an activation warp normally used on doors with a time window for when it can be used. Note that you must use 24-hour times, i.e. 2000 for 8pm.
Example: 6 29 SeedShop 900 2100
Buildings Action LuauSoup Used for the Luau Festival, this is where you insert a food item for the soup.
Buildings Action MagicInk Adds the Magic Ink to your wallet.
Buildings Action Mailbox Shows the next letter from the player's mailbox (if any).
Buildings Action Material Shows a summary of the player's stockpiled wood and stone.
Buildings Action Message <string messageKey> Loads a message with the given key from the Content\Strings\StringsFromMaps.xnb file and displays it in a dialogue box.
Buildings Action MessageOnce <int eventID> <string message> If the player hasn't seen the event with ID <eventID>, marks that event seen and displays the given message text in a dialogue box. This does not parse dialogue format.
Buildings Action MessageSpeech <string messageKey> Identical to Action Message, but replaces the usual inspection cursor with a speech cursor.
Buildings Action MineSign <string message> Shows a mini-dialogue box with the given raw message text. This does not parse dialogue format.
Buildings Action MinecartTransport Shows the minecart destination menu (or a message if not unlocked).
Buildings Action MineElevator Shows the mine elevator menu (to warp to a mine level) if the player has reached mine level 5+, else a mine elevator not working message.
Buildings Action NextMineLevel Warps the player to the next mine level (or level 1 if they're not in the mine).
Buildings Action Notes <int noteID> If the player has found the specified lost book, displays its museum note text and marks it read.
Example: Action Notes 17
Buildings Action NPCMessage <str name> "<str dialogueKey>" If the named NPC is within 14 tiles of the player, reads dialogue with the given key from the string files and displays a dialogue box. See dialogue format.
Example: Action NPCMessage Abigail "Strings\\StringsFromCSFiles:Event.cs.1022"
Buildings Action playSound <str cueName> Play the sound or music with the given name.
Buildings Action QiCoins Shows a dialogue which lets the player buy 10 Casino club coins if they have none, else shows how many they have.
Buildings Action Saloon Opens the Saloon menu, if Gus is nearby.
Buildings Action SandDragon Used for Part 3 of the Mysterious Mr. Qi Quest.
Buildings Action Shop On festival maps, opens the festival shop. No effect on non-festival maps.
Buildings Action Theater_BoxOffice Opens the ticket menu for the theater, if you have it unlocked.
Buildings Action TownMailbox <ID> TODO: Explain what this does.
Buildings Action Warp <int x> <int y> <str area> Warps the player to the <x> <y> tile coordinate in the <area> game location.
Example: Action Warp 76 9 Mountain
Buildings Action WarpCommunityCenter Warps the player to the inside of the Community Center if they have access (else show an "it's locked" message).
Buildings Action WarpGreenhouse Warps the player to the inside of their greenhouse if they've unlocked it, else shows a message about the greenhouse ruins.
Buildings Action WizardBook If unlocked, you buy buildings from the wizard here.
Buildings Action WizardHatch If you're good enough friends with the wizard you warp to his basement, if not you get told you can't go in.
Buildings Action WizardShrine Shows the character customisation menu normally available from the Wizard's tower.

¹ Tile properties are handled throughout the codebase using GameLocation::doesTileHaveProperty. Actions and touch actions are handled by GameLocation::performAction and GameLocation::performTouchAction respectively. Emote IDs are listed as Character constants.
² The T value (short for true) is conventional, but any non-empty value will work too.

Paths layer

The Paths layer has icon tiles from the paths tilesheet which affect game behavior on the map:

The tile indexes shown in the table.
tile index explanation restrictions
0–7 No effect? TODO: verify how the pathing logic uses it.
8 Add this tile to the Light map property with light type 4 (sconce). Indoors and festivals only.²
9–12 Spawn a tree when the location is created. Outside the farm, 50% chance to respawn each day. (See also 31–32.)
Available trees: oak (9), maple (10), pine (11), and palm 1 (12).
Outdoors only.
13–18 Spawn debris when the location is created, or randomly each day. Outside the farm, respawn in spring.
Available debris: seasonal weed (13–15), rock (16–17), twig (18).
Outdoors only.
19 Spawn a large log when the farm is created, with the top-left corner on this tile. Farm only.
20 Spawn a boulder the farm is created, with the top-left corner on this tile.. Farm only.
21 Spawn a hardwood stump when the farm is created (and every day on the forest farm), with the top-left corner on this tile. Farm only.
22 Spawn grass when the location is created, or randomly afterwards. Outdoors only.
23 Spawn a random oak, maple, or pine tree at growth stage 2–3 when the location is created. Outdoors only.
24–26 Spawn a normal bush when the location is created. Medium bushes grow blackberries and salmonberries.
Available bushes: large (24), medium (25), small (26).
Outdoors only.
27 When the location is created, add this tile to the BrookSounds map property with the babblingBrook sound. Outdoors only.
28 Spawn a grub here (33% chance per day, unless the map already has 50 grubs). Mutant Bug Lair only.
29–30 Place prebuilt cabins in multiplayer based on the layout (29=nearby or 30=separate) and Order tile property, with the top-left corner on this tile. Farm only.
31–32 Spawn a tree when the location is created. Outside the farm, 50% chance to respawn each day. (See also 9–12.)
Available trees: palm 2 (31), mahogany (32).
Outdoors only.
33 Spawn a golden walnut bush when the location is created. Outdoors only.

Notes:

  1. In the Mutant Bug Lair, debris spawn rate is reduced to 33% chance per day.
  2. Restriction can be overridden with forceLoadPathLayerLights map property.

Potential issues

Tilesheet order

When you replace a vanilla map, don't change the order or IDs of the original tilesheets. Prefix new tilesheet IDs with z_ to avoid changing the original order.

Why this causes problems
For example, let's say you replace a map which normally has these tilesheets in Tiled:
The original tilesheet order.
When you add a new tilesheet, note that the order changes from [paths, untitled tile sheet] to [customSheet, paths, untitled tile sheet]:
Wrong way to add a new tilesheet (changes the original order).
If the game tries to access a tile from the first tilesheet, it will get it from customSheet instead of the expected Paths tilesheet. That can cause anything from visual glitches (e.g. showing the wrong tile images) to outright crashes (especially if the new tilesheet is smaller than the one it expected).
To avoid that, always keep the original tilesheets in the same order and prefix new tilesheets with z_ so they're added at the end:
Correct way to add a new tilesheet.
How to fix an affected tilesheet
See "mod reordered the original tilesheets" below.

Local copy of a vanilla tilesheet

When editing a map in Tiled, you may need to copy vanilla tilesheets like path.png or spring_town.png into the map folder for Tiled to find. If the tilesheet is still there when you load the game, SMAPI will use it for your map instead of the game's vanilla tilesheet, which may have unintended effects (e.g. edits from recolor mods won't work in your map).

To avoid issues, you can either...

  • Delete vanilla tilesheets from the folder before testing or releasing the mod.
  • Rename the tilesheet file to start with a dot (like .spring_town.png) and reference that. When SMAPI loads the map in-game, it'll automatically ignore the dot and look for spring_town.png in the local files or Content/Maps folder.

Map-specific issues

The game makes some assumptions about maps which may break for modded maps. These are the known issues:

affected maps issue
Maps/Farm
Maps/Farm_Combat
Maps/Farm_Fishing
Maps/Farm_Foraging
Maps/Farm_Mining
  • The farm's Paths layer must have at least one tile with index 22 (grass spawn). This is used to initialise the grass code when the save is loaded, even if no grass is spawned.[1]
Maps/FarmHouse*
  • The two bed tiles where the player can walk must have two properties: Bed T (used to decide if the player is in bed) and TouchAction Sleep.
  • Deleting or changing the wallpapers and floors will cause a game crash.
  • The DayTiles and NightTiles map properties are cleared when loading the spouse room, so custom values for those properties won't work for married players.
Maps/SpouseRooms
  • If you add or resize any tilesheet, you must also edit Maps/FarmHouse1_marriage and Maps/FarmHouse2_marriage to have the same changes (even if you don't make any other changes to the farmhouse). This is needed because the tilesheet references and sizes are stored as part of the map file.
  1. The grass sound is set in Grass::loadSprite, which is called from GameLocation::loadObjects if the Paths layer has tile index 22. (The game spawns a grass for each such tile, and later removes them.)

'Save as' in Tiled

When you use 'save as' in Tiled, never save into a different folder. That will change all the tilesheet references to point to the old folder, so it'll no longer work in-game. Instead, copy/move the map files to a different folder if needed.

Locating tilesheets in Tiled

When a map tilesheet is missing, never use the locate option to use a tilesheet from a different folder. That will add a complex tilesheet path which won't work in-game. Instead copy the tilesheets into the same folder as the map, and reference them from there.

Troubleshooting

See also potential issues above for common issues.

"Tilesheet paths must be a relative path without directory climbing (../)"

What does this mean?
Your map uses a tilesheet that's outside its folder root. That might happen if you used 'save as' in Tiled to save into a different folder, copied & pasted tiles between maps in different folders, or manually added a tilesheet from a different folder.
For example:
📁 Stardew Valley/
   📁 Content/
      📁 Maps/
         🗎 townInterior     <──┐
   📁 Mods/                    │
      📁 YourModName/          │ ../../../Content/Maps/townInterior
         📁 assets/            │
            🗎 your-map.tmx  ───┘
This isn't allowed since it's very fragile (e.g. players might install your mod in a different folder path).
How do I fix it?
  1. Copy the tilesheets you're using into the same folder as the map.
  2. For unchanged vanilla tilesheets, rename them to start with a dot (like .townInterior.png). This tells SMAPI to ignore the file when loading the map in-game, and load the one in the Content folder instead.
  3. In Tiled, click the edit icon under the tilesheet.
  4. In the tab that opens, click Tileset > Tileset Properties.
  5. Click the 'Image' field, then the 'Edit' button to locate the tilesheet in the same folder.

For a screenshot guide of steps 3-5, see these images provided by Discord user foggywizard#7430.

After fixing it, the above example would look like this:
📁 Stardew Valley/
   📁 Mods/
      📁 YourModName/
         📁 assets/
            🗎 your-map.tmx       ───┐
            🗎 .townInterior.png  <──┘ .townInterior.png

"mod reordered the original tilesheets"

What does this mean?
See tilesheet order for more info.
How do I fix it?
Always keep the original tilesheets in the same order and prefix new tilesheets with z_ so they're added at the end:
Correct way to add a new tilesheet.
To rename an affected tilesheet in Tiled:

"mod has no tilesheet with ID '<name>'"

What does this mean?
You replaced one of the vanilla maps, but your custom map doesn't have all of the original map's tilesheets (or you changed their names in Tiled). This will cause a crash if the game tries to access the missing tilesheet.
How do I fix it?
Compare the original and custom maps in Tiled. For each tilesheet in the original map, make sure it's also in the custom map and has the same name (even if you're not using it).
If you need to rename a tilesheet:
  1. In the tileset pane, click the tab for the tileset and then click the edit icon.
  2. Click Tileset > Tileset Properties from the top menu to show the properties pane.
  3. Change the Name field to match the original map's tilesheet name.

Making changes with SMAPI

This page mainly covers editing maps with Tiled, but you can make the same changes programmatically using a C# SMAPI mod. There are two main approaches to changing a location in C# code.

Using an asset editor

Most map edits should be applied using an asset editor, so your changes aren't lost if another mod reloads the map. This works with the Map asset directly before it's used by the in-game location, so you can't use location methods at this point.

First you'll need to set up an asset editor, which mainly involves implementing IAssetEditor on your mod class. For example, this mod code edits the town map:

/// <summary>The mod entry point.</summary>
internal class ModEntry : Mod, IAssetEditor
{
    /// <inheritdoc />
    public override void Entry(IModHelper helper) { }

    /// <inheritdoc />
    public bool CanEdit<T>(IAssetInfo asset)
    {
        return asset.AssetNameEquals("Maps/Town");
    }

    /// <inheritdoc />
    public void Edit<T>(IAssetData asset)
    {
        IAssetDataForMap editor = asset.AsMap();
        Map map = editor.Data;

        // your code here
    }

    /// <summary>Get a tile from the map.</summary>
    /// <param name="map">The map instance.</param>
    /// <param name="layerName">The name of the layer from which to get a tile.</param>
    /// <param name="tileX">The X position measured in tiles.</param>
    /// <param name="tileY">The Y position measured in tiles.</param>
    /// <returns>Returns the tile if found, else <c>null</c>.</returns>
    private Tile GetTile(Map map, string layerName, int tileX, int tileY)
    {
        Layer layer = map.GetLayer(layerName);
        Location pixelPosition = new Location(tileX * Game1.tileSize, tileY * Game1.tileSize);

        return layer.PickTile(pixelPosition, Game1.viewport.Size);
    }
}

Now you can make any changes you want to the map before it's loaded by location. For example, you can...

  • Add a custom tilesheet:
    map.AddTileSheet(new TileSheet(
        id: "z_custom-tilesheet", // always prefix custom tilesheets with z_ to avoid reordering vanilla tilesheets
        map: map,
        imageSource: this.Helper.Content.GetActualAssetKey("assets/tilesheet.png", ContentSource.ModFolder), // get a unique asset name for local mod file which can be passed to the game
        sheetSize: new Size(32, 64), // the size in tiles for the tilesheet image
        tileSize: new Size(16)       // the size of each tile in pixels, should always be 16
    ));
    
  • Manage map properties:
    // get a property value
    string currentMusic = map.Properties.TryGetValue("Music", out PropertyValue rawMusic)
        ? rawMusic.ToString()
        : null;
    
    // add/replace a property
    map.Properties["Music"] = "MarlonsTheme";
    
    // delete a property
    map.Properties.Remove("Music");
    
  • Manage tile properties:
    // get tile
    Tile tile = this.GetTile(map, layerName: "Back", tileX: 10, tileY: 20);
    if (tile == null)
        return; // you should handle the tile not being there to avoid errors
    
    // get a property value
    string diggable = tile.TileIndexProperties.TryGetValue("Diggable", out PropertyValue rawDiggable) || tile.Properties.TryGetValue("Diggable", out rawDiggable)
        ? rawDiggable?.ToString()
        : null;
    
    // set a property
    tile.Properties["Diggable"] = "T";
    
    // delete a property
    tile.Properties.Remove("Diggable");
    
  • Add new tiles:
    int tileX = 10;
    int tileY = 20;
    Layer layer = map.GetLayer("Back");
    
    // add a static tile
    layer.Tiles[tileX, tileY] = new StaticTile(
        layer: layer,
        tileSheet: map.GetTileSheet("z_custom-tilesheet"),
        tileIndex: 100,            // the sprite index in the tilesheet
        blendMode: BlendMode.Alpha // should usually be Alpha
    );
    
    // add an animated tile
    layer.Tiles[tileX, tileY] = new AnimatedTile(
        layer: layer,
        tileFrames: new StaticTile[]
        {
            new StaticTile(...),
            new StaticTile(...),
            new StaticTile(...),
        },
        frameInterval: 100 // frame duration in milliseconds
    );
    
  • Delete tiles:
    layer.Tiles[tileX, tileY] = null;
    
  • Apply tile transformations:
    Tile tile = this.GetTile(map, layerName: "Back", tileX, tileY);
    tile.Properties["@Rotation"] = 45; // rotate it 45° clockwise
    tile.Properties["@Flip"] = 1; // flip the tile: 0 (normal), 1 (horizontal), 2 (vertical)
    

See also SMAPI's map edit helper, which lets you do things like merge a custom map area into the map.

After location is loaded

After the in-game location is loaded, you can edit locations and their maps using the game's helpers. Be careful doing this though: another mod (or sometimes the game itself) may reload the location at any time, which would lose your changes if you're not careful.

For example, within any in-game events you can...

  • Access the map to use the methods described above:
    Map map = location.map;
    
  • Manage tile properties:
    Town town = (Town)Game1.getLocationFromName("Town");
    int tileX = 10;
    int tileY = 20;
    
    // get property value
    string diggable = town.doesTileHaveProperty(tileX, tileY, "Diggable", "Back");
    
    // set property value
    location.setTileProperty(tileX, tileY, "Back", "Diggable", "T");
    
  • Manage tiles:
    location.removeTile(tileX, tileY, "Back");
    

See also