You are viewing a potentially older version of this package. View all versions.
DFG-SafeHarbor-1.0.29 icon

SafeHarbor

Build a dry dock for longships and skiffs. Shift+D cradles the ship; the dock menu can deploy it, board it, or open its hold.

By DFG
Date uploaded 2 weeks ago
Version 1.0.29
Download link DFG-SafeHarbor-1.0.29.zip
Downloads 298
Dependency string DFG-SafeHarbor-1.0.29

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2333 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2333
ValheimModding-Jotunn-2.30.2 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.30.2

README

Report a bug or buy us a coffee at dfgaming.net.

Safe Harbor

Buildable ship docks that do the seamanship for you. Steer a longship, karve, or raft up to an open berth, press a key at the rudder, and the ship eases into a cradle, lifts out of the water, and is dry-docked. Press the key again to slide it back out to the water. Docking persists across save and reload.

A Valheim BepInEx 5 plugin built on Jotunn.

Features

  • Two buildable dock pieces (Hammer > DFG):
    • Safe Harbor Dock (longships) — 40 Wood / 20 Fine Wood / 10 Iron. Uses the included dock.glb.
    • Safe Harbor Skiff Dock (karves and rafts) — 20 Wood / 8 Fine Wood / 3 Iron.
  • Shift+D at the rudder docks or undocks. The ship eases into the berth and lifts clear of the water.
  • Dock controls on the dock: dock a nearby ship, deploy it, board it, or open its hold.
  • Status lights on the dock: green when the berth is open, red when a ship is docked.
  • The docked ship and its berth are saved with the world. The ship is repaired when it docks.
  • Indestructible by default.

Requirements

  • BepInEx 5 (denikson-BepInExPack_Valheim)
  • Jotunn 2.30.x (ValheimModding-Jotunn)

Installation

  1. Install through your mod manager (recommended).
  2. Manual: copy this folder to BepInEx\plugins\DFG-SafeHarbor\. Keep SafeHarbor.dll, dock.glb, and dock_icon.jpg together.
  3. Restart Valheim. The build pieces are registered at startup.

How to use

  1. Build Safe Harbor Dock from the Hammer under DFG and place it at the shore. The ghost sits the underside on the ground or the water.
  2. Steer a ship within range of the dock.
  3. At the rudder, press Shift+D to dock. Press it again to undock. The ship slides out to the water.
  4. Walk up to the dock and press E on the dock controls.
Key Action
Shift+D Dock or undock while steering
E Open the dock menu
1 Dock a nearby ship
2 Deploy the docked ship
3 Board the docked ship
4 Open the docked ship's hold
Esc Close the menu
Alt+L Open the in-game tuner

While a ship is docking, Deploy and Board stay unavailable until it has settled.

Configuration

Generated on first launch at BepInEx\config\com.safeharbor.safeharbor.cfg.

Section Key Default Description
General Enabled true Master toggle.
General AddBuildPiece true Add the docks to the Hammer. Restart.
General ShowHudPrompt true Show the dock hint while steering nearby.
General ShowMessages true Message when a ship docks or undocks.
General StatusLights true Green = open, red = occupied. Restart.
General DebugLogging true Write docking details to the BepInEx log.
Controls DockKey Left Shift + D Dock and undock at the rudder.
Controls GuiKey Left Alt + L Open the in-game tuner.
Docking DockRange 50 How far (meters) a ship can be and still dock.
Docking DockDuration 2.5 Seconds to ease into the berth.
Docking UndockDuration 1.5 Seconds to slide back out.
Docking LiftHeight 1.8 Meters the ship is raised above the water.
Docking UndockDistance 20 How far forward the ship is released.
Docking UndockSpeed 4 Push (m/s) when the ship is released.
Docking MaxDockSpeed 3 Ship must be slower than this to dock. 0 disables the check.
Dock Berths 1 Ships one large dock can hold. Restart.
Dock Indestructible true The dock takes no damage.
Dock AddPilings true Support posts under the dock. Restart.
Dock PilingLength 20 Piling length in meters. Restart.
SmallDock Enabled true Also add the skiff dock. Restart.
Blueprint WebTuner true Serve the local alignment page.
Blueprint WebPort 8781 Tuner address is http://127.0.0.1:8781/.

Model alignment (position, berth, ship level, and the three status-light nudges) is stored in BepInEx\config\safeharbor_model.json. With the web tuner on, open http://127.0.0.1:8781/ while the game is running and save from that page.

The skiff dock can still use a PlanBuild blueprint (safeSkiff.blueprint or smallDock.blueprint) when one is found.

Changelog

See CHANGELOG.md.

Support

If this mod has made your journey through the Tenth World a little better, consider tossing a coin into my Ko-fi jar: https://ko-fi.com/draugrforgedgaming. Your support keeps the forge hot and the mead flowing! Skål!

CHANGELOG

Changelog

All notable changes to Safe Harbor.

[1.0.29]

  • The large dock is the included dock.glb model. dock.glb and dock_icon.jpg ship next to the DLL.
  • Press E on the dock controls to dock a nearby ship, deploy it, board it, or open its hold.
  • A ship docked again after undocking stays registered, so Deploy, Board, and Dock storage stay available.
  • Status lights sit on the model's lanterns: green when the berth is open, red when a ship is docked.
  • The placement ghost keeps the dock underside on the shore or the water.
  • The web tuner saves berth, ship level, and the three light nudges to safeharbor_model.json.

[1.0.4]

  • New harbor icon: a docked longship with green and amber berth lanterns.

[1.0.3]

  • The package page now points to dfgaming.net to report a bug or buy a coffee.

[1.0.2]

  • Safe Harbor Dock and Safe Harbor Skiff Dock now show on the Hammer DFG tab. They are added to the live Hammer build table after the world loads, with real Wood, Fine Wood, and Iron costs.

[1.0.1]

  • Bug fixes and improvements to docking, appearance, and the web tuner.

[1.0.0] - Initial release

  • Buildable "Safe Harbor Dock" and "Safe Harbor Skiff Dock" pieces (Hammer > Misc) via Jotunn.
  • Dock ships into a berth, lift and dry-dock them (physics frozen), auto-repair on dock, and persist docking across save/reload.
  • Undock slides the ship clear and gives it a forward push.
  • Per-berth status lamps (green/red), in-game tuner GUI (Alt+L), and web tuner on port 8781.
  • Optional PlanBuild/Infinity Hammer blueprint docks with per-piece JSON tuning.
  • Config: General / Controls / Blueprint / Docking / Dock / SmallDock sections.