MSchmoecker-PressurePlate icon

PressurePlate

A pressure plate for opening and closing doors

Last updated 2 weeks ago
Total downloads 6410
Total rating 4 
Categories Mods Misc Utility
Dependency string MSchmoecker-PressurePlate-0.4.3
Dependants 13 other mods depend on this mod

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.1500 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.1500
ValheimModding-Jotunn-2.3.0 icon
ValheimModding-Jotunn

Jötunn (/ˈjɔːtʊn/, 'giant'), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Preferred version: 2.3.0

README

Pressure-Plate

About

Adds a pressure plate, which opens and closes doors within a range if a player stands on it.

  • Wooden pressure plate: 3 wood, 1 surtling core with the hammer. Requires a workbench in range
  • Stone pressure plate: 3 stone, 1 surtling core with the hammer. Requires a stonecutter in range

showcase

Ingame settings

config

  • Trigger Radius: if a player is inside this range, the plate is pressed
  • Door Radius: all doors inside this radius are opened/closed
  • Activation Time: duration in which the plate is pressed
  • Trigger Delay: duration it takes before the plate is pressed
  • Invert Doors: inverts open/closed state
  • Ignore wards: allows other players to open doors even they have no access

Installation

Extract the content of Pressure-Plate into the BepInEx/plugins folder.

Development

Inside the repo are two folders, PressurePlate for the mod and UnityAssets for the Unity files.

Mod Setup

Create a file called Environment.props inside the project root. Copy the example and change the Valheim install path to your location. If you use r2modman you can set the path too, but this is optional.

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <!-- Needs to be your path to the base Valheim folder -->
        <VALHEIM_INSTALL>E:\Programme\Steam\steamapps\common\Valheim</VALHEIM_INSTALL>
        <!-- Optional, needs to be the path to a r2modmanPlus profile folder -->
        <R2MODMAN_INSTALL>C:\Users\[user]\AppData\Roaming\r2modmanPlus-local\Valheim\profiles\Develop</R2MODMAN_INSTALL>
    </PropertyGroup>
</Project>

This requires the publicized Valheim dlls. See here for example: https://github.com/CabbageCrow/AssemblyPublicizer

Unity Setup

This step is only needed if you want to compile the AssetBundle.

Place all needed Unity, Valheim and dependencies assemblies in the UnityAssets/Assets/Assemblies folder. See PressurePlate/PressurePlate.csproj for reference. If some are still missing, Unity prints the name of a missing dependencies to the console.

Build the AssetBundle with the Unity toolbar "Assets/Build AssetBundles" to automatically copy the resulting file to the mod folder.

Adding custom door config

Custom door settings can be applied for every door type. This can only be done with code and is an optional for other mods. Vanilla items are configurable, too.

Here is a quick instruction:

  1. Add this mod .dll to your assembly references. The next step ensures that everything works if a user doesn't have pressure plate installed.

  2. Check if the mod is loaded:

    const string pressurePlateGUID = "com.maxsch.valheim.pressure_plate";
    if (Chainloader.PluginInfos.ContainsKey(pressurePlateGUID)) {
        // next steps...
    }
    

    This should be done at your plugins Start(). If you use Awake() and your mod is loaded first it may not detect it properly. Any following steps can be done whenever you like, even after the loading phase.

  3. Create the config: DoorConfig config = new DoorConfig();

    It takes two optional parameters:

    • bool openClosedInverted, default: false
    • float openTime, default: 1

    This may requires using PressurePlate;

  4. Add the config to the gameobject:

    const prefabName = "your_door_piece_name";
    DoorConfig.AddDoorConfig(prefabName, config);
    

    or directly with your prefab

    GameObject door = myDoorPrefab;
    DoorConfig.AddDoorConfig(door.GetComponent<Door>(), config);
    

Changelog

0.4.3

  • Fixed incompatibility with H&H update

0.4.2

  • Added german translation
  • Show plate name in UI and mouse hover
  • Fixed input field text was not visible because of Jötunn 2.2.8

0.4.1

  • Fixed trigger delay was ignored when the player left the plate, resulting in pressing the plate for a fraction of time
  • Fixed trigger delay was not reset when the player left the plate

0.4.0

  • Added UI to configure each plate individually
  • Renamed "public/private" to "ignore wards"
  • Removed global player settings

0.3.1

  • Only show public/private option when the plate is inside an active ward
  • Limited radius of configurable radius to 8 units
  • Fixed a null error when destroying doors while standing on a pressure plate

0.3.0

  • Added option to set plates public, this allows plates to bypass wards
  • Fixed multiplayer async, resulting in opening a door after it was closed

0.2.1

  • Fixed null error when placing a new door, as no ZNetView exists yet
  • Fixed not opening a door if the player presses the plate while the door is closing

0.2.0

  • Reworked internally how a pressure plate opens doors
  • Modders can now set custom configurations for doors. This includes if the open/close is reversed and opening time
  • A pressure plate no longer interrupts a open or close animation

0.1.0

  • Replaced ValheimLib with Jotunn, everything is backwards compatible

0.0.6

  • Added configuration: PressurePlateRadiusHorizontal
  • Added configuration: PressurePlateRadiusVertical
  • Added configuration: PressurePlatePlayerRadiusHorizontal
  • Added configuration: PressurePlatePlayerRadiusVertical
  • Added configuration: PressurePlateOpenDelay

0.0.5

  • Added stone pressure plate
  • Updated wood pressure plate icon
  • Changed Language tokens: $pressure_plate -> $pressure_plate_wood, added $pressure_plate_stone

0.0.4

  • Updated ValheimLib to 0.0.15
  • Reverted last fix as it was fixed in ValheimLib
  • Removed unnecessary 'valheim.exe' restriction
  • Removed HookGenPatcher dependency

0.0.3

  • Fixed "Destroyed invalid prefab ZDO..."-bug when moving through portals

0.0.2

  • Added sound effects for pressing and releasing pressure plate

0.0.1

  • Release

Links

Nexusmods: https://www.nexusmods.com/valheim/mods/498

Thunderstore: https://valheim.thunderstore.io/package/MSchmoecker/PressurePlate/

Github: https://github.com/MSchmoecker/Valheim-Pressure-Plate

Credits

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2021-9-16 0.4.3 635 Version 0.4.3 Install
2021-9-12 0.4.2 213 Version 0.4.2 Install
2021-8-22 0.4.1 551 Version 0.4.1 Install
2021-8-21 0.4.0 61 Version 0.4.0 Install
2021-7-27 0.3.1 678 Version 0.3.1 Install
2021-7-12 0.3.0 300 Version 0.3.0 Install
2021-6-6 0.2.1 806 Version 0.2.1 Install
2021-6-2 0.2.0 215 Version 0.2.0 Install
2021-5-13 0.1.0 716 Version 0.1.0 Install
2021-5-9 0.0.6 255 Version 0.0.6 Install
2021-5-4 0.0.5 275 Version 0.0.5 Install
2021-4-6 0.0.4 653 Version 0.0.4 Install
2021-3-20 0.0.3 598 Version 0.0.3 Install
2021-3-15 0.0.2 315 Version 0.0.2 Install
2021-3-14 0.0.1 139 Version 0.0.1 Install