You are viewing a potentially older version of this package. View all versions.
MilkyTeam-OathBound-0.1.2 icon

OathBound

The next boss stays sealed until every player on the server has defeated the previous one. Server synced.

Date uploaded 2 months ago
Version 0.1.2
Download link MilkyTeam-OathBound-0.1.2.zip
Downloads 86
Dependency string MilkyTeam-OathBound-0.1.2

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2350 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.2350

README

OathBound

The next boss stays sealed until every player on the server has defeated the previous one. Fast players wait for the group; nobody skips ahead. Server synced, live config reload.

Features

  • Each boss altar only works once everyone in the group has defeated the boss before it. The altar says who the group is still waiting for.
  • Credit is per player: everyone who hit the boss is credited, plus everyone within a configurable distance when it dies. Admins can grant or revoke credit.
  • The roster fills itself as players log in. Players who have been away for a configurable number of days stop holding the group back, and admins can ignore or forget players.
  • New players catch up automatically with everything the world has already cleared (configurable).
  • Installing mid-playthrough is safe: bosses the world had already defeated count as cleared for everyone.
  • The chain is a YAML file, so modded bosses can be added and the order changed.
  • Server enforces its settings for all connected players; "Lock Configuration" prevents clients from overriding them

How to Install

  1. Install BepInEx for Valheim.
  2. Install this mod on the server and on every client. Clients without it are rejected by the server.

For manual install, drag OathBound.dll into the BepInEx/plugins folder.

Console commands

Run from the in-game console (F5). The changes are made on the server and answered there.

oathbound status                    every stage: open or waiting for whom, and the roster
oathbound grant <player> <stage>    credit a player with a boss           (admin)
oathbound revoke <player> <stage>   take that credit away                 (admin)
oathbound ignore <player>           the player never holds the group back (admin)
oathbound unignore <player>         count the player again                (admin)
oathbound forget <player>           remove the player from the roster     (admin)

<player> is a name or a player ID, <stage> is a stage name from the chain (Eikthyr, TheElder, Bonemass, Moder, Yagluth, TheQueen, Fader) or its global key.

Files

  • OathBound.cfg: credit radius, inactive days, late joiner mode, gate options. Hot reloaded, synced.
  • OathBoundChain.yml: the chain of stages, one entry per boss with its order, global key and boss prefab. Hot reloaded, synced.
  • OathBound.<world>.roster.yml: written by the server, one entry per player with last seen, ignored flag and cleared stages. Hot reloaded when an admin edits it.

Building

Requirements: .NET SDK 8, Valheim installed with BepInEx, and the ValheimModLibs repository checked out next to this one. pack.ps1 builds the mod and creates a Thunderstore zip in thunderstore/.

dotnet build OathBound/OathBound.csproj -c Release

CHANGELOG

Changelog

0.1.2

  • Fixed a frame rate loss caused by the exception-tagging finalizer the shared library attached to every patched game method; it is removed.
  • YAML files starting with a byte order mark are accepted.

0.1.1

  • Config hot reload polls the file every five seconds instead of using a file watcher, which on Linux dedicated servers fired for the mod itself reading the file and hung the server at startup in an endless reload loop. The roster file is polled the same way.
  • No warning on the first run when the example OathBoundChain.yml is written.

0.1.0

  • First working version: roster, credit by attackers and radius, altar gate with spawn guard, console commands, YAML chain, late joiner catch-up, inactive days, mid-playthrough backfill