Swim Mod now accepts content packs! Swim Mod content packs allow you to specify dive locations and edge warps between maps and add features to underwater maps.

Swim mod content packs don't add maps, so if you want to add your own underwater maps, you'll have to create them yourself and add them using a separate TMXL content pack.

There's an example mod in the optional files for LemurKat's Escape to East Scarpe mod that has both a TMXL [TMX] content pack with a new underwater map and a Swim Mod Info [SMI] content pack to allow diving and add underwater features (more below).  I'm using [SM] as the main folder prefix that houses both content packs.

For info on creating a TMXL map content pack, please see the documentation for TMXL Map Toolkit.


Swim Mod Info [SMI] Content Pack Instructions:

Your [SMI] content pack needs only a manifest.json and a content.json file, formatted as follows:


manifest.json

The manifest.json file is standard for content packs, but make sure to add proper dependencies. Here's the example for the underwater East Scape SMI pack



{
"Name": "Underwater East Scarpe Swim Mod Info",
"Author": "aedenthorn",
"Version": "0.1.0",
"Description": "Adds swim mod info to LemurKat's East Scarpe and its underwater map.",
"UniqueID": "aedenthorn.UnderwaterEastScarpeSMI",
"MinimumApiVersion": "2.0",
"ContentPackFor": {
"UniqueID": "aedenthorn.Swim",
"MinimumVersion": "0.9.0"
},
"Dependencies": [
{
"UniqueID": "aedenthorn.Swim",
"IsRequired": true
},
{
"UniqueID": "aedenthorn.UnderwaterEastScarpeTMX",
"IsRequired": true
},
{
"UniqueID": "LemurKat.EastScarpe.TMX",
"IsRequired": true
},
]
}


Notice that it requires aedenthorn.UnderwaterEastScarpeTMX which is the accompanying TMXL content pack. LemurKat.EastScarpe.TMX is the TMX map for Escape to East Scarpe.


content.json

content.json has a single maps node that contains an array of maps and their information. Note that there can only be one dive map info for each map in the game. If you try to add dive map info for a map that already has it, it will fail.

The example pack has info for two maps, the existing EastScarpe map and the new UnderwaterEastScarpe map, in order to allow diving between them:

{
    "maps":[
        {
            "Name":"UnderwaterEastScarpe",
            "Features":[
                "SmolFishies",
                "Crabs",
                "OceanTreasure",
                "OceanResources",
                "Underwater",
                "FixWaterTiles"
            ],
            "DiveLocations": [
                {
                    "OtherMapName":"EastScarpe",
                },
            ],
        },
        {
            "Name":"EastScarpe",
            "Features":[
                "FixWaterTiles"
            ],
            "DiveLocations": [
                {
                    "OtherMapName":"UnderwaterEastScarpe",
                },
            ],
        },
    ]
}

Name should be the GameLocation name (for custom maps, the name given to TMXL in the addMaps node).


Features can include the following:

• SmolFishies: adds smol fishies like in the Underwater Beach map
• BigFishies: adds big fishies like in the Underwater Mountain map
• Crabs: adds hermit and chest crabs like in the Underwater Beach map
• OceanTreasure: Adds possible treasure chests with treasure taken from the fishing game
• OceanResources: adds forageables like seaweed and clams
• Underwater: tells Swim Mod that this is an underwater map to deplete oxygen and other things. If this is included, you NEED a DiveLocation of the same size without specific warp positions as the last DiveLocation, so it can warp there once you run out of oxygen.
• FixWaterTiles: many maps have some impassable water tiles that you can't swim through. Setting this will try to make them passable for this map.
  

• StartX: the horizontal tile coordinate where this dive spot begins (optional)
• StartY: the vertical tile coordinate where this dive spot begins (optional)
• Width: how many tiles wide the dive spot is (optional)
• Height: how many tiles tall the dive spot is (optional)
• OtherMapName: the GameLocation name of the map this dive spot leads to
• OtherMapPos: the position on the other map to dive to, with its own X and Y nodes (see below) (optional)