Give Feedback
0 of 0
About this mod
The Map binder will allow the registration of one or more instances of a map from either a TMX file or one of the internal game assets, additionally it can strip warps built into the map. If Warp Binder is detected additional warp files can be bundled with your maps.
- Requirements
- Permissions and credits
- Changelogs
- Donations
Map Binder allows a user to register new Game Locations using either internal game assets or their own TMX files. With the ability to strip warps embedded into maps, create multiple unique instances from the same maps, and even creating maps that can be shared between save files, Map Binder allows for some off the wall game play.
Defining a Map
Maps are defined by using one of two file types, a BMAP file is a json file denoting that the asset is from the base game where as a CMAP file denotes that the asset to be used is a custom TMX file. The name needs to be unique.
Note: If you set the CrossSaveMap to true it will allow the map to be accessed by all save files, however this can cause some strange effects as the maps day/season is controlled by the loaded save and not the map itself. I do plan on looking into custom time tracking for shared maps but it will take some time to implement, and as I am in the middle of implementing content packs first it is on the back burner.
Example: This example adds in another farm of the Fishing type, with a warp file available (requires Warp Binder) in the Maps folder relative to the mod. It will also disable the warps built into the map, however due to having the "Farm" override certain farm buildings will appear on the map. If you enter them and exit them you will be back on the main farm.
Example File: "Demo.bmap"
Example Contents:
Example: This loads up the kVala map as a farmable map, but as a standard location type so the farm buildings will not show up. Again with a warp file denoted (requires Warp Binder).
Example File: "Demo.cmap"
Example Contents:
Content Packs
As of (v.1.1.0) content packs are supported, to create a content pack target your manifest to "SnowFire.Map_Binder" and list each desired map file in a file called content.json as shown below. All folders are relative to your content packs folder and can not go higher than your content packs folder root. Once you have these basics in, just ensure that your map files and any additional files they point to are in the correct locations in your packs folders and Map Binder will take care of the rest.
Bug Catchers
Because they are the unsung heroes of the software development world.
- ty2manie
Discord / Comms
I can be found lurking in these Discord servers, though in the Stardew Valley server I tend to keep to the Making and Using mods sections for obvious reasons. While I may not be in voice chat during the day (I work 0800-1700 Pacific Time) I do check in via my phone.
Stardew Valley Discord
NightSong Discord
The Vales
Defining a Map
Maps are defined by using one of two file types, a BMAP file is a json file denoting that the asset is from the base game where as a CMAP file denotes that the asset to be used is a custom TMX file. The name needs to be unique.
Note: If you set the CrossSaveMap to true it will allow the map to be accessed by all save files, however this can cause some strange effects as the maps day/season is controlled by the loaded save and not the map itself. I do plan on looking into custom time tracking for shared maps but it will take some time to implement, and as I am in the middle of implementing content packs first it is on the back burner.
Example: This example adds in another farm of the Fishing type, with a warp file available (requires Warp Binder) in the Maps folder relative to the mod. It will also disable the warps built into the map, however due to having the "Farm" override certain farm buildings will appear on the map. If you enter them and exit them you will be back on the main farm.
Example File: "Demo.bmap"
Example Contents:
{
"Asset": "Maps/Farm_Fishing",
"MapUniqueName": "kVala",
"Outdoors":true,
"Farm":true,
"Greenhouse":false,
"CrossSaveMap": false,
"PurgeMapWarps": true,
"MapTypeOverride": "Farm",
"WarpFiles": ["Maps/DemoWarpSVE.warp"]
}
Example: This loads up the kVala map as a farmable map, but as a standard location type so the farm buildings will not show up. Again with a warp file denoted (requires Warp Binder).
Example File: "Demo.cmap"
Example Contents:
{
"Asset": "Maps/kVala.tmx",
"MapUniqueName": "kVala",
"Outdoors":true,
"Farm":true,
"Greenhouse":false,
"CrossSaveMap": false,
"PurgeMapWarps": true,
"WarpFiles": ["Maps/DemoWarpSVE.warp"]
}
Content Packs
As of (v.1.1.0) content packs are supported, to create a content pack target your manifest to "SnowFire.Map_Binder" and list each desired map file in a file called content.json as shown below. All folders are relative to your content packs folder and can not go higher than your content packs folder root. Once you have these basics in, just ensure that your map files and any additional files they point to are in the correct locations in your packs folders and Map Binder will take care of the rest.
{
"MapList":[
"Internal/Maps/ExtraFarm_Cave.bmap",
"Custom/Maps/Vales/kVala.cmap",
"Custom/Maps/Vales/kTreva.cmap",
"Custom/Maps/Vales/kValdemar.cmap",
"Custom/Maps/Other/Hardorn.cmap"
]
}
Bug Catchers
Because they are the unsung heroes of the software development world.
- ty2manie
Discord / Comms
I can be found lurking in these Discord servers, though in the Stardew Valley server I tend to keep to the Making and Using mods sections for obvious reasons. While I may not be in voice chat during the day (I work 0800-1700 Pacific Time) I do check in via my phone.
Stardew Valley Discord
NightSong Discord
The Vales