Monster Sanctuary Archipelago Client

This is a client mod for Monster Sanctuary that makes it compatible with the Archipelago Multiworld Randomizer.

This mod features randomization for all items and monsters through Archipelago.

NOTE: This mod is currently in its alpha stage. Features are likely to be broken and there will be bugs. The fastest way to report bugs is to message me (Saagael) directly on Discord, though anyone is welcome to add issues here on github. If you can, include a screenshot of the problem as well as any error messages in the console.

Installation

• Must be using a PC version of Monster Sanctuary that is on the latest update
• Download the latest version of this mod from this link.
• Extra and copy the zip file into the root folder where Monster Sanctuary is located. By default it should be something like: C:\Program Files (x86)\Steam\steamapps\common\Monster Sanctuary
  • Windows likes to place an intermediary folder when extracting zip files. Make sure that the BepInEx folder, doorstop_config.ini, and winhttp.dll are all located directly in the game's install folder.
• Launch the game and close it. This will finalise the installation for BepInEx.
• Launch the game again and you should see a new bit of UI in the top-left of the screen showing Archipelago v0.4.4 Status: Not Connected, as well as text fields to enter connection info.
• To uninstall the mod, either remove/delete the Archipelago.MonsterSanctuary folder from the plugins folder, or rename the winhttp.dll file in the game's root directory (this will disable all mods from running)

Generating a Multiworld

• In order to setup a multiworld you must first install the latest version of Archipelago
  • When running the Archipelago setup exe you'll want to at least install the Generator and Text Client
• After installing, run Archipelago Launcher and click on Browse Files. This will open the local file directory for your Archipelago installation.
• Download the yaml template file Place MonsterSanctuary.yaml inside the Players folder
  • The yaml file needs to be edited before you can generate a game. Open the file and fill in your player name and choose the settings you want.
  • You will also need to get the .yaml files for everyone who is joining your multiworld and place them inside
• Download the latest version of the .apworld file from this link.
• Place the monster_sanctuary.apworld file inside of lib/worlds.
• Once all of the .yaml files have been configured and placed into Players, click Generate in the Archipelago Launcher.
• A .zip file will be created in the output folder containing information for your multiworld. In order to host your game, go to https://archipelago.gg/uploads and upload the .zip file, then click Create New Room.

Connecting to a Room

Once you start the game with the client mod, you can connect to an AP server by selecting either "New Game" or "Continue". If you are starting a new file, you will be prompted to enter the connection information for the AP server. This informatoin is then saved along with the game's file slot, and will allow you to quickly reconnect when continuing the save file.

When you want to Continue a save file, if that save file has connection information associated with it, you will be prompted to connect to that AP server before loading the game.

NOTE: The client mod prevents you from loading an AP save file while not connected to AP, and will not let you load a vanilla save file while connected to AP.

PopTracker

Many thanks for Cybe3R for getting us set up with a PopTracker pack. Follow the instructions on that page to set up PopTracker.

Randomizer Options

• randomize_monsters:

  • Randomization rules for monsters
  • 0: Monsters are not randomized
  • 1: Monsters are entirely randomized, with every monster replaced with any other monster
  • 2: Monsters of the same specie are all randomized to another monster specie (this is how the built-in randomizer works)
  • 3: Within a given encounter, all monsters of the same specie are randomized to another specie. Each encounter is randomized entirely separately.

• monster_shift_rule:

  • When do shifted monsters start appearing in the wild?
  • 0: Never
  • 1: After Sun Palace
  • 2: At any time

• improved_mobility_limit

  • Restrict placement of monsters with improved mobility abilities (improved flying, improved swimming, dual mobility, and lofty mount)
  • 0: Do not restrict placement of these monsters
  • 1: Monsters with these abilities will not show up in the Mountain Path, Blue Caves, Stronghold Dungeon, Snowy Peaks, Sun Palace, or Ancient Woods.

• include_spectral_familiars_in_pool

  • Adds all four spectral familiars to be included in the randomized monster pool
  • 0: Do not include spectral familiars in the pool
  • 1: Include spectral familiars in the pool

• include_bard_in_pool

  • Adds Bard to be included in the randomized monster pool
  • 0: Do not include Bard in the pool
  • 1: Include Bard in the pool

• randomize_monster_skill_trees

  • When enabled, each monster specie will have three or four randomly selected skill trees rather than their normal skill trees
  • 0: Do not randomize skill trees
  • 1: Randomize monster skill trees

• randomize_monster_ultimates

  • When enabled, each monster specie will have its three ultimate skills randomized
  • 0: Do not randomize ultimate skills
  • 1: Randomize monsters' ultimate skills

• randomize_monster_shift_skills

  • When enabled, each monster specie will have its light and dark shift skills randomized
  • 0: Do not randomize shift skills
  • 1: Randomize monsters' shift skills

• cryomancer_check_restrictions

  • Sets how to handle the four Lady Stasis / Cryomancer checks in Snowy Peaks.
  • 0: The location will contain its vanilla items (Dodo eggs and reward box lvl 2)
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• old_man_check_restrictions

  • Sets how to handle the Old Man by the Sea (Memorial Ring) check in Horizon Beach.
  • 0: The location will contain its vanilla item
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• fisherman_check_restrictions

  • Sets how to handle the Fisherman (5 Rare Seashells) check in Horizon Beach.
  • 0: The location will contain its vanilla item
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• wanderers_gift_check_restrictions

  • Sets how to handle the Wanderer's gift check for collecting 3 Celestial Feathers and defeating Dracomer in the Forgotten World.
  • 0: The location will contain its vanilla item
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• koi_egg_placement

  • Sets how to handle the Caretaker's Koi egg gift check
  • 0: The location will contain its vanilla item (Koi Egg).
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• skorch_egg_placement

  • Sets how to handle Bex's Skorch egg gift check
  • 0: The location will contain its vanilla item (Skorch Egg).
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• bard_egg_placement

  • Sets how to handle the Bard egg gift check
  • 0: The location will contain its vanilla item (Bard Egg).
  • 1: The location is randomized with everything else
  • 2: The location will contain a junk item

• spectral_familiar_egg_placement

  • Sets how to handle the four gift checks given by each of the spectral familiars in Eternity's End
  • 0: The four spectral familiar gift checks will contain their respective egg (Spectral Wolf will give the spectral wolf egg, etc)
  • 1: The four spectral familiar gift checks will be randomized with everything
  • 2: The four spectral familiar gift checks will contain junk items

• monsters_always_drop_egg:

  • If enabled, monsters will always give their egg as a battle reward. Evolved monsters will give their unevolved form's egg.
  • 0: Disabled
  • 1: Enabled

• monsters_always_drop_catalyst:

  • If enabled, evolved monsters will always give their catalyst as a battle reward
  • 0: Disabled
  • 1: Enabled

• include_chaos_relics:

  • Are chaos relics included in the random item pool?
  • 0: No
  • 1: Yes

• include_looters_handbook:

  • Add the "Looter's Handbook" item to the item pool. When the player has this item in their inventory, chest sprites will update to match their contents: purple chests contain progression items, green chests contain useful items, and brown chests contain filler items. Traps can be in chests of any color.
  • 0: No
  • 1: Yes

• automatically_scale_equipment:

  • When enabled, all weapon and accessory items are automatically scaled to match the player's progress
  • 0: Disabled. Weapon and accessory levels are randomized when the item pool is generated
  • 1: By level. Weapons and accessories are scaled with the highest monster level the player has
  • 2: By rank. Weapons and accessories are scaled with the number of champions the player has defeated
  • 3: By map progress. Weapons and accessories are scaled with the percentage of the map the player has uncovered

• key_of_power_champion_unlock:

  • Sets the number of champions that must be defeated in order for the player to receive the Key of Power. If set to 0, this is disabled, and the Key of power will be in the item pool. If set from 1 and 26, when that number of champions are defeated, the player will be given the Key of Power
  • Range from 0 to 26

• add_smoke_bombs:

  • Start with 50 smoke bombs.
  • 0: No
  • 1: Yes

• starting_gold:

  • Set your starting gold. This value is multiplied by 100 to determine starting gold.
  • Range from 0 to 1000

• drop_chance_craftingmaterial:

  • Controls the relative frequency that a random non-progression item is a crafting material
  • Range from 0 to 100

• drop_chance_consumable:

  • Controls the relative frequency that a random non-progression item is a consumable
  • Range from 0 to 100

• drop_chance_food:

  • Controls the relative frequency that a random non-progression item is a food item
  • Range from 0 to 100

• drop_chance_catalyst:

  • Controls the relative frequency that a random non-progression item is a catalyst
  • Range from 0 to 100

• drop_chance_weapon:

  • Controls the relative frequency that a random non-progression item is a weapon
  • Range from 0 to 100

• drop_chance_accessory:

  • Controls the relative frequency that a random non-progression item is an accessory
  • Range from 0 to 100

• drop_chance_currency:

  • Controls the relative frequency that a random non-progression item is gold
  • Range from 0 to 100

• skip_plot

  • Disable all flags and checks that require progressing the game's story. This allows entering areas before you would normally be able to
  • 0: No
  • 1: Yes

• remove_locked_doors

  • Removes locked doors
  • 0: Do not remove any locked doors
  • 1: Remove extraneous locked doors such that each area only has one place where keys are used
  • 2: Remove all locked doors

• local_area_keys

  • Controls where area keys can be placed
  • 0: Area keys can show up anywhere in any world (following normal logic rules)
  • 1: Area keys will only show up in the Monster Sanctuary player's world, and they will only appear in their own area

• open_blue_caves:

  • If enabled, the Blue Caves to Mountain Path shortcut will start opened
  • 0: Disabled
  • 1: Enabled

• open_stronghold_dungeon:

  • Opens shortcuts and entrances within and to the Stronghold Dungeon
  • 0: Disabled
  • 1: Entrances. Opens up entrances to the Dungeon from the Blue Caves and Ancient Woods
  • 2: Shortcuts. Opens up interior gates and shortcuts within the Dungeon
  • 3: Fully open. Opens both Entrances and Shortcuts

• open_ancient_woods:

  • If enabled, opens up alternate routes to access the Brutus and Goblin King fights.
  • NOTE: These shortcuts allow you to bypass the need for Ancient Woods Keys. It is recommended to only use this setting if locked doors are turned off.
  • 0: Disabled
  • 1: Enabled

• open_snowy_peaks:

  • If enabled, opens up shortcuts within Snowy Peaks
  • 0: Disabled
  • 1: Enabled

• open_sun_palace:

  • Opens shortcuts and entrances within and so Sun Palace
  • 0: Disabled
  • 1: Entrances. Opens the gate between Snowy Peaks and Sun Palace
  • 2: Raise Pillar. Raises the central pillar, lowers the water level, and opens the east and west shortcuts
  • 3: Fully open. Opens both Entrances and raises the pillar

• open_horizon_beach:

  • Opens shortcuts and entrances within and to Horizon Beach
  • 0: Disabled
  • 1: Entrances. Opens the elemental door locks between Ancient Woods and Horizon Beach, as well as the Magma Chamber to Horizon Beach shortcut
  • 2: Shortcuts. Opens the shortcut in central Horizon Beach
  • 3: Fully open. Opens both Entrances and Shortcuts

• open_magma_chamber:

  • Opens shortcuts and entrances within and to the Magma Chamber
  • 0: Disabled
  • 1: Entrances. Opens the rotating gates between Ancient Woods and Magma Chamber, and the breakable wall between Forgotten World and Magma Chamber
  • 2: Lower Lava. Removes the runestone shard from the item pool, lowers the lava, and opens all interior shortcut gates
  • 3: Fully open. Opens both Entrances and Lowers Lava

• open_blob_burg:

  • Opens up Blob Burg
  • 0: Disabled
  • 1: Entrances. Removes the blob key from the item pool and makes Blob Burg start opened up with no requirements
  • 2: Open Walls. Opens up all areas within Blob Burg, removing the need to incremementally open via chests.
  • 3: Fully open. Opens both Entrances and all Walls

• open_forgotten_world:

  • Opens shortcuts and entrances within and to Forgotten World
  • 0: Disabled
  • 1: Entrances. Opens alternative entrances to Forgotten World from Horizon Beach and Magma Chamber
  • 2: Shortcuts. Opens one-way shortcuts in the Forgotten World
  • 3: Fully open. Opens both Entrances and Shortcuts

• open_mystical_workshop:

  • If enabled, opens up the northern shortcut within Mystical Workshop
  • NOTE: This shortcut allows you to bypass the need for Mystical Workshop Keys. It is recommended to only use this setting if locked doors are turned off
  • 0: Disabled
  • 1: Enabled

• open_underworld:

  • Opens shortcuts and entrances within and to the Underworld
  • 0: Disabled
  • 1: Entrances. Removes sanctuary tokens from the item pool and opens up the Underworld door in Blue Caves, as well as the shortcut between Sun Palace and the Underworld
  • 2: Shortcuts. Opens all shortcuts and enables all grapple points
  • 3: Fully open. Opens both Entrances and Shortcuts

• open_abandoned_tower:

  • Opens shortcuts and entrances within and to the Abandoned Tower
  • 0: Disabled
  • 1: Entrances. Removes the key of power from the item pool and opens both doors between Mystical Workshop and Abandoned Tower
  • 2: Shortcuts. Opens the shortcuts within Abandoned Tower
  • 3: Fully open. Opens both Entrances and Shortcuts

• hints:

  • Enables various hints throughout the world
  • 0: Hints are disabled
  • 1: Hints are enabled

• goal:

  • Victory condition for the game
  • 0: Defeat Mad Lord
  • 1: Defeat all champions

Note on Drop Chance Settings

The seven options to control relative drop frequency for different items works such that the higher the value is compared to the other drop item types, the more frequently it will occur.

For example, if the drop_chance_weapon value is twice the value of all other item types, then weapons show up, on average, twice as often as the everything else. If a drop chance is set to 0, it will never occur.

A more complicated example: If drop_chance_catalyst is set to 10, and drop_chance_food is set to 20, and everything else is set to 40, then catalysts will appear 1/4 as frequently as non-food items and half as frequently as food. While food will appear twice as frequently as catalysts and half as frequently as everything else.