LordAshes-RoomViewPlugin icon

RoomViewPlugin

Automatic hide/reveal of hide volumes (rooms) based on mini location

Last updated a week ago
Total downloads 6167
Total rating 3 
Categories Tweaks Networked Tools Integration Assets Minis
Dependency string LordAshes-RoomViewPlugin-4.0.0
Dependants 1 other package depends on this package

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-LoggingPlugin-1.0.1 icon
LordAshes-LoggingPlugin

Provides unified logging functionality

Preferred version: 1.0.1

README

Room View Plugin

This unofficial TaleSpire plugin automatically hides/reveals hide volumes (e.g. rooms) based on mini location(s). Support multiple minis with ability for minis to split up and minis (e.g. foes) that don't hide/reveal.

Video Link: https://youtu.be/1-w5j3WUPdg

This plugin, like all others, is free but if you want to donate, use: http://LordAshes.ca/TalespireDonate/Donate.php

Install

Use R2ModMan or similar installer to install this plugin.

Initial Rooms Setup

This needs to be done once per board. It does NOT need to be repeated each time the board is loaded.

  1. Start Talespire
  2. Create hide volumes for each area (e.g. room)

See tips below for making compatible rooms

Revealing Minis

Any minis that a player has been assigned permission to are considered PC minis (i.e. revealers). All minis which no player has permissions for are considered non PC minis (i.e. not revealers).

Room View Usage

Re-Hide Mode On (Sight Mode):

Moving minis into a new room will reveal the new room. Moving minis out of a room will hide the room.

Re-Hide Mode Off (Explorer Mode):

Moving minis into a new room will reveal the new room. Moving minis out of a room will keep the room revealed.

Configurations

Rehide Empty Rooms: If true, empty rooms will rehide. If false, empty rooms remain revealed. Preview: If true, rooms are shown as soon a mini is moved into the room. If false, mini must be dropped to reveal room.

Configuration is only available outside the game. There is currently no hot-keys for switching these settings in game.

Creating Areas (Rooms) Compatible With Room View Plugin

Any tile that is in any Hide Volume that is hidden will not be shown. As such the following tips are recommended when making areas for the Room View plugin:

  1. Use double walls. By using double walls, no matter which room is shown, the wall will be there. If only a single wall, between rooms, is used then it can only be included as part of one hide volume and thus will appear as a hole when that hide volume is hidden.

  2. Use double door. For the same reason as above, if a double door is used, one of the two doors will be visible no matter which of the adjoining rooms is visible. This does mean opening two doors when a door is opened but if only a single door is used, one of the two adjoining rooms will have a hole when visisble.

  3. If using elevation, try to keep the elevation the same at the boundary points of hide volumes or do not include the floor as part of the hide volume.

  4. If you want an effect such a being able to always see the outside walls of a building (so it can be seen when standing outside the building) but not reveal any of the interior rooms, create the outer wall so that it is not in the hide volumes. This way such walls will always be visible regardless of the location of the minis.