0 of 0
About this mod
This mod adds a hatch and ladder to the game as items you can purchase in Robin's shop. Use the hatch to access the cellar directly from the farm, and use the ladder to access the farm directly from the cellar - this makes it possible to go between the cellar and the farm without having to walk through the farmhouse.
- Requirements
- Permissions and credits
- Changelogs
- Donations
I liked the idea of the Cellar Door mod by NotOnLand but unfortunately that mod no longer works as DGA is not supported by 1.6, so I made this mod. It functions in game basically the same as NotOnLand's mod, but uses Content Patcher and SpaceCore instead of DGA.
Instructions:
1. Download Cellar Hatch, unzip it and put the unzipped file in your mods folder.
Review config options in Generic Mod Config Menu (or edit the values in config.json) before using:
2. When you want the items to be available for purchase in Robin's shop, check the box next to "Stock items" in GMCM (or set "Stock items" to "true" in config.json).
Note: You do not need to have the cellar farmhouse upgrade to purchase and use the hatch and ladder. However, if you do not have the cellar upgrade, you must use the ladder to exit the cellar. If you try using the stairs before you have the cellar upgrade you will get stuck and will have to use a debug warp command in SMAPI to get unstuck.
*After purchasing the hatch and ladder, I recommend that you uncheck the box next to "Stock items" (or set "Stock items" to "false" in config.json) so that the items wont spawn daily in Robin's shop inventory and take up space there.
3. The hatch and ladder sprites are available in a vanilla color and a VPR recolor (credit to grapeponta's amazing Vibrant Pastoral Recolor mod for the assets!). Choose either "vanilla" or "VPR" in GMCM (or set "Color" to "vanilla" or "VPR" in config.json).
4. You can choose the orientation of the hatch: if you want the hatch to face to the left or down, choose "left & down" in GMCM (or set "Orientation" to "left & down" in config.json). If you want the hatch to face to the right or up, choose "right & up" in GMCM (or set "Orientation" to "right & up" in config.json)
5. You can choose to have the hatch warp you to the left or to the right of the cellar stairs in GMCM (or set "Warp to cellar" to "left of cellar stairs" or "right of cellar stairs" in config.json).
*I recommended that you place the ladder in the corresponding spot in the cellar for immersion. So if you choose to have the hatch warp you to the left of the cellar stairs, place the ladder to the left of the cellar stairs.
6. You can choose to have the ladder warp you next to the upper left or upper right corner outside the farmhouse (for the Standard, Riverland, Forest, Hill-top, Wilderness, Four-Corners and Beach farms) in GMCM (or set "Warp to farm" to "upper left farmhouse exterior" or "upper right farmhouse exterior" in config.json).
*I recommend that you place the hatch near the corresponding spot outside the farmhouse for immersion. So if you choose to have the ladder warp you next to the upper left corner outside the farmhouse, place the hatch near the upper left corner of the farmhouse.
*If you're playing on the Meadowlands farm and want to warp next to the upper left or upper right corner outside the farmhouse, make sure to use the "Warp to farm": "upper left Meadowlands farmhouse" or "upper right Meadowlands farmhouse" options.
Compatibility:
This mod should be compatible with any mod that alters the farm and/or cellar maps, but you may want to alter the coordinates for the warp locations, especially if the farmhouse on your map is in another location compared to the vanilla farms and/or you're using a mod that changes the layout of the cellar.
Setting custom warp coordinates:
This is my first mod and while I've tested it pretty thoroughly, it's very possible I missed something. I tried many different configurations of the hatch and ladder and this seems to be the most optimal in terms of configuration and offering compatibility with other mods that alter the farm and/or cellar maps. However, if you have any questions, comments, suggestions, or notice any bugs, please don't hesitate to let me know!
Note: *I haven't tested the items outside the farm map*
Instructions:
1. Download Cellar Hatch, unzip it and put the unzipped file in your mods folder.
Review config options in Generic Mod Config Menu (or edit the values in config.json) before using:
2. When you want the items to be available for purchase in Robin's shop, check the box next to "Stock items" in GMCM (or set "Stock items" to "true" in config.json).
Note: You do not need to have the cellar farmhouse upgrade to purchase and use the hatch and ladder. However, if you do not have the cellar upgrade, you must use the ladder to exit the cellar. If you try using the stairs before you have the cellar upgrade you will get stuck and will have to use a debug warp command in SMAPI to get unstuck.
*After purchasing the hatch and ladder, I recommend that you uncheck the box next to "Stock items" (or set "Stock items" to "false" in config.json) so that the items wont spawn daily in Robin's shop inventory and take up space there.
3. The hatch and ladder sprites are available in a vanilla color and a VPR recolor (credit to grapeponta's amazing Vibrant Pastoral Recolor mod for the assets!). Choose either "vanilla" or "VPR" in GMCM (or set "Color" to "vanilla" or "VPR" in config.json).
4. You can choose the orientation of the hatch: if you want the hatch to face to the left or down, choose "left & down" in GMCM (or set "Orientation" to "left & down" in config.json). If you want the hatch to face to the right or up, choose "right & up" in GMCM (or set "Orientation" to "right & up" in config.json)
5. You can choose to have the hatch warp you to the left or to the right of the cellar stairs in GMCM (or set "Warp to cellar" to "left of cellar stairs" or "right of cellar stairs" in config.json).
*I recommended that you place the ladder in the corresponding spot in the cellar for immersion. So if you choose to have the hatch warp you to the left of the cellar stairs, place the ladder to the left of the cellar stairs.
6. You can choose to have the ladder warp you next to the upper left or upper right corner outside the farmhouse (for the Standard, Riverland, Forest, Hill-top, Wilderness, Four-Corners and Beach farms) in GMCM (or set "Warp to farm" to "upper left farmhouse exterior" or "upper right farmhouse exterior" in config.json).
*I recommend that you place the hatch near the corresponding spot outside the farmhouse for immersion. So if you choose to have the ladder warp you next to the upper left corner outside the farmhouse, place the hatch near the upper left corner of the farmhouse.
*If you're playing on the Meadowlands farm and want to warp next to the upper left or upper right corner outside the farmhouse, make sure to use the "Warp to farm": "upper left Meadowlands farmhouse" or "upper right Meadowlands farmhouse" options.
Compatibility:
This mod should be compatible with any mod that alters the farm and/or cellar maps, but you may want to alter the coordinates for the warp locations, especially if the farmhouse on your map is in another location compared to the vanilla farms and/or you're using a mod that changes the layout of the cellar.
Setting custom warp coordinates:
Spoiler:
Show
Hatch:
If you want the hatch to warp you to a location of your choosing, go to the Cellar Hatch mod folder and open the content.json file with a text editor like Notepad++ or Sublime (you can download either for free). Scroll down to where you find this string and follow the instructions:
"Warp to cellar": "custom"
},
"Entries": {
"{{ModId}}_CellarHatch": {
"TileProperties": {
"0, 0": {
"Buildings": {
//You can change where the hatch warps you
//In game, stand where you want to warp to in the cellar and type " debug
ppp " (dont' include the quotations) into SMAPI and hit enter to get
your desired coordinates
//Make note of the coordinates and close the game
//Replace the numbers below in "Warp 7 7 Cellar" with the numbers from your desired coordinates
"Action": "Warp 7 7 Cellar",
Dont change anything else! Save your changes and close the text editor. Now when you select "custom" for "Warp to cellar" in GMCM (or set "Warp to cellar" to "custom" in config.json) the hatch will warp you to your chosen location in the cellar.
Ladder:
If you want the ladder to warp you to a location of your choosing, go to the Cellar Hatch mod folder and open the content.json file with a text editor like Notepad++ or Sublime (you can download either for free). Scroll down to where you find this string and follow the instructions:
"Warp to farm": "custom"
},
"Entries": {
"{{ModId}}_CellarLadder": {
"TileProperties": {
"0, 0": {
"Buildings": {
//You can change where the ladder warps you
//In game, stand where you want to warp to on the farm and type " debug ppp "
into SMAPI (dont' include the quotations) and hit enter to get your
desired coordinates
//Make note of the coordinates and close the game
//Replace the numbers in "Warp 70 12 Farm" below with the numbers from your desired coordinates
"Action": "Warp 70 12 Farm"
Dont change anything else! Save your changes and close the text editor. Now when you select "custom" for "Warp to farm" in GMCM (or set "Warp to farm" to "custom" in config.json) the ladder will warp you to your chosen location on the farm.
This is my first mod and while I've tested it pretty thoroughly, it's very possible I missed something. I tried many different configurations of the hatch and ladder and this seems to be the most optimal in terms of configuration and offering compatibility with other mods that alter the farm and/or cellar maps. However, if you have any questions, comments, suggestions, or notice any bugs, please don't hesitate to let me know!
Note: *I haven't tested the items outside the farm map*