You are viewing a potentially older version of this package. View all versions.
BarryWhite-BossGatedPortals-1.3.2 icon

BossGatedPortals

Portal progression: ores and metals teleport once their biome's boss is beaten, and new worlds get a portal limit that grows with each boss. Optional: mounts, carts and tames travel with you; faster portals. Works with XPortal and TargetPortal.

Date uploaded a month ago
Version 1.3.2
Download link BarryWhite-BossGatedPortals-1.3.2.zip
Downloads 501
Dependency string BarryWhite-BossGatedPortals-1.3.2

This mod requires the following mods to function

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
denikson-BepInExPack_Valheim-5.4.2351 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.2351

README

BossGatedPortals Plus

A progression mod for Valheim portals:

  • Ores and metals can go through portals once that biome's boss is beaten. Each boss unlocks its own biome's goods.
  • A world portal limit that grows with each boss killed: 2 portals at the start, more after every boss, no limit after the last one. On for new worlds only.

Optional extras (companions that travel with you, faster portals) are off by default.

Works with XPortal and TargetPortal. All settings are server-synced and editable live with F1.

Progression (on by default)

  • One tier per boss, each unlocking its biome's items. Item lists are configurable.
  • Unlock rule (UnlockWhen): the boss killed on this world (default), or also each player having picked up the boss drop, or the drop alone. CumulativeTiers lets a later tier unlock earlier ones.
  • The final tier unlocks everything. A NeverTeleport list keeps items blocked forever.
  • Everything you carry counts: your inventory, backpacks (AdventureBackpacks, Backpacks, RustyBags), and anything a mod brings through with you (a cart, tames' saddlebags).
  • Hints when a portal refuses you say where the item is ("in your Cart") and which part of the world still has to be conquered. They never name a boss.
  • Portals only glow when you can go through, and tooltips and inventory icons show what you can teleport right now.
  • Unlock announcements to everyone on a boss's first kill.
  • For admins: portalgate status and portalgate limit on/off console commands, optional AdminBypass, and startup checks that log item typos, duplicates and conflicting mods.

Portal limit (on for new worlds)

  • Caps how many portals the whole world can hold (everyone's together). Defaults: 2 before any boss, then 4, 6, 8, 10, 12, 16, 20, and no limit after the final boss (each tier's MaxPortals).
  • New worlds only. A world that already has portals when the server first loads it with this mod is left without a limit, so installing or updating never locks anyone's portals. Admins can switch a world with portalgate limit on/off.
  • Building over the limit is refused before any materials are used.
  • PortalLimitLockWhenOver (on): while the world is over its limit, no portal works until enough are destroyed. The mod never removes portals.
  • PortalLimitAdminsExempt (off) lets admins build past the limit (their portals still count).
  • PortalLimitCountStonePortals (on): Stone Portals count like wood ones. Off = they don't count, can always be built, and keep working when the world is over its limit.
  • Counts vanilla, XPortal and TargetPortal portals. Portal pieces from other mods only count if that mod registers them as game portals.

Optional extras (off by default)

Travel with your companions (5 - Travel)

  • Mount: ride into a portal and arrive in the saddle.
  • Cart: arrives hitched to you, or to your horse (OdinHorse).
  • Tames: following, named, or all tames nearby, with radius, height, headcount and creature lists.
  • Works through vanilla, XPortal and TargetPortal portals. Their cargo follows the same rules as your inventory. Steps aside while TeleportEverything is on.

Faster portals (4 - Portal Speed)

  • FadeSeconds (default 1) and MinimumLoadingSeconds (default 8) match the game. Lower them, down to 0. Real loading is never skipped.
  • Steps aside while QuickTeleport, FastTeleport or Proper Portals is installed.

Installation

Requires: BepInExPack_Valheim, Jotunn.

  • Install on the server and every client, with the same major.minor version (e.g. any 1.3.x).
  • Gale / r2modman: install BossGatedPortals as usual.
  • Manual: copy BossGatedPortals.dll to BepInEx/plugins/BossGatedPortals/.

Config: BepInEx/config/BarryWhite.BossGatedPortals.cfg. Settings from 0.2.x carry over automatically.

Tiers (defaults)

Tier Biome Unlocks
T0 Meadows nothing
T1 Black Forest CopperOre, Copper, CopperScrap, TinOre, Tin, Bronze, BronzeScrap
T2 Swamp IronOre, IronScrap, Iron, Ironpit
T3 Mountains SilverOre, Silver, DragonEgg
T4 Plains BlackMetalScrap, BlackMetal
T5 Mistlands MechanicalSpring, DvergrNeedle
T6 Ashlands FlametalOreNew, FlametalNew, FlametalOre, Flametal, CharredCogwheel
T7 Deep North GoldOre, Gold, and everything else

Hildir's chests never teleport unless HildirChestsByTier is on.

Per-tier settings:

Setting Meaning
GlobalKey World key set by the boss kill
BossItem Boss drop the player must have held (when UnlockWhen asks for it)
Items Items unlocked, comma-separated
Hint Shown when blocked
UnlockMessage Announced on first kill
AllowEverything T7 only: unlock all blocked items
MaxPortals Portal limit once this boss is killed. -1 = no limit

Settings

All admin-only and server-synced, except 8 - Client, which each player sets for themselves.

Section Setting Default Description
1 - General Enabled true Master switch
UnlockWhen BossKilled BossKilled (on this world, for everyone), BossKilledAndDropHeld (each player must also have held the boss drop) or DropHeld
CumulativeTiers false A later tier unlocks all earlier tiers
2 - Item Rules NeverTeleport (empty) Items never teleportable
HildirChestsByTier false Hildir's chests unlock with their biome's tier (Brass T1, Silver T3, Bronze T4)
LockListedItemsAlways false Also lock listed items the game or another mod already lets through
FinalTierIncludesCheatTier false T7 also unlocks tool-tier 1000+ items
RespectVanillaAllowAll true Stone Portals carry every item, as in vanilla. false = they follow the tiers
3 - Messages HintFormat An item{where} blocks the portal. {hint} Placeholders {hint}, {where}, {item}. Empty = the game's message
AnnounceTierUnlock true Announce first boss kills
AccurateTooltips true Per-player tooltips and icons
4 - Portal Speed FadeSeconds 1 Screen fade into and out of a teleport. 0 = instant
MinimumLoadingSeconds 8 Shortest loading screen. 0 = no built-in delay
5 - Travel BringMount false Your mount comes through and you're remounted
BringCart false Your cart comes through and is hitched back up
BringTames false Tames near you come through. The Tame… settings only apply while this is on
↳ TameMode Following Following, FollowingOrNamed, Named or AllTamed. Tames following another player never come
↳ TameRadius 10 Metres around you
↳ TameHeightRange 3 Metres above/below you
↳ TameMaxCount 5 Most tames per trip, nearest first
↳ TameAllowList (empty) If set, only these creatures (e.g. Wolf, Lox)
↳ TameBlockList (empty) These creatures never come
↳ TameIncludeSummons false Also staff summons that follow you
6 - Compatibility GateCompanionCargo true Gate cart cargo and tame saddlebags when another mod brings them along
WarnOnConflictingMods true Warn about conflicting mods and settings
7 - Admin AdminBypass false Admins ignore the gate
StatusCommand true Enable portalgate status
LogItemChecks true Log unknown item names, items in two tiers, and blocked items no tier lists
8 - Client HintPosition Centered Centered or TopLeft
HintCooldownSeconds 5 Seconds between hints (0–60)
9 - Portal Limit PortalLimitEnabled true World portal limit, raised by each tier's MaxPortals. New worlds only. The settings below only apply while this is on
↳ PortalLimitStart 2 Portals allowed before any boss is killed
↳ PortalLimitAdminsExempt false Admins can build past the limit
↳ PortalLimitMessage This world holds {count} of {limit} portals. … Shown when a portal can't be built
↳ PortalLimitLockWhenOver true While over the limit, no portal works
↳ PortalLimitOverMessage This world has too many portals ({count} of {limit}). … Shown at a locked portal
↳ PortalLimitCountStonePortals true Stone Portals count toward the limit

Compatibility

Tested in game with XPortal 1.2.25, TargetPortal 1.2.7, AdventureBackpacks 2.4.5, Backpacks 1.3.10, OdinHorse 1.7.5 and LoxSaddleBags 2.0.2. The rest was checked by reading their code.

  • Portal mods: XPortal, TargetPortal, Unified Target Portal, XPortalNetworks, PortalRules, PotalMap, Better Portal, Portal Stations, Waypoints and Waystones all use the game's item check, so the tiers apply.
  • Portal speed mods (QuickTeleport, FastTeleport, Proper Portals): Portal Speed steps aside; use their settings. Proper Portals' "carry anything" doesn't override this mod.
  • Bags: AdventureBackpacks, Smoothbrain's Backpacks and RustyBags bags are gated like your inventory. ExtraSlots and AzuExtendedPlayerInventory slots count as your inventory.
  • Tames: when TeleportEverything or Waypoints brings tames along, their saddlebags are gated too (LoxSaddleBags, OdinHorse, or any container on a tame). Set TeleportEverything's TransportRestrictedItems (the 1.0 fork: Transport Ores) to false, or it lets everything through.
  • Carts and ships: a cart a mod pulls through with you is gated. BottleShips bottles arrive empty. ValheimRAFT's ship portals only move the player.
  • Mods that change items: if a mod makes a tier-listed item teleportable, the log says so once. LockListedItemsAlways = true locks it anyway.
  • Warned at startup: mods or settings that let every item through or add their own gate (e.g. TeleportEverything, AzuMiscPatches, ValheimPlus, ServersideQoL's PortalProgression and TameAssist, AdvancedPortals, ReturnScroll, TeleportationMeads, and the portal mods' "ignore items" options).
  • Not gated: ways to move items without portals (shipping mods, cross-server portals, admin commands).

Known limits

  • Checks run client-side; a modified client can bypass them.
  • Mounts, carts and tames only travel through vanilla, XPortal and TargetPortal portals. A cart you pull is still checked through other map-teleport mods.
  • The portal count reaches players every 2 seconds, so two players building at the same moment can go one over the limit (PortalLimitLockWhenOver makes that pointless).
  • A mod that blocks world keys (e.g. Server Devcommands' DisableGlobalKeys) can keep the portal limit off.
  • With PortalLimitCountStonePortals off, a Stone Portal still locks when you jump from TargetPortal's map while the world is over its limit.
  • After Valheim updates, check the log for LogItemChecks warnings.

Source and bug reports

Source code and bug reports are on GitHub. MIT licensed.

Credits

CHANGELOG

Changelog

1.3.3

  • Fixed a memory leak: with some mods installed, memory use slowly grew the longer you played.

1.3.2

  • AdventureBackpacks 2.4.5 added code to support this mod, which clashed with it: a backpack holding ore stayed blocked at portals even after that ore's boss was defeated. This mod is adjusted to work with it.

1.3.0

  • New: PortalLimitCountStonePortals (9 - Portal Limit, default true). true = Stone Portals follow the portal limit like wood portals (as in 1.2.0). false = Stone Portals are left out of the limit: they don't count, can always be built, and keep working while the world is over its limit.
  • The portal limit counts portals once per frame on a host or single-player game, instead of once per portal glow (cheaper with many portals).
  • Clearer description for RespectVanillaAllowAll: it's about letting every item through Stone Portals.
  • README: clearer wording on Stone Portals, which portals the limit counts, and the portalgate limit command.
  • New minor version: the server and every player need 1.3.x.

1.2.0

  • New main feature: portal limit (9 - Portal Limit). Caps how many portals the whole world can hold: 2 at the start, raised each time a boss is killed (each tier's new MaxPortals: 4, 6, 8, 10, 12, 16, 20, then no limit). Fewer portals early means more travel and exploration.
  • On for new worlds only. The first time the server loads a world with this version, a world without portals gets the limit and a world that already has portals is left alone, so updating never locks anyone's portals. Admins can switch a world with portalgate limit on / off; portalgate status shows it.
  • Building a portal over the limit is refused before materials are used. With PortalLimitLockWhenOver (on), no portal works while the world is over its limit, until enough are destroyed. Portals are never removed.
  • PortalLimitAdminsExempt (off) lets admins build past the limit.
  • New minor version: the server and every player need 1.2.x.

1.1.1

  • TargetPortal fix: on TargetPortal's portal map, a portal icon with another map pin on or next to it can now be clicked (before, the click hit the other pin and nothing happened). Portal icons are also drawn on top of other pins while that map is open.
  • Bug fix only: 1.1.0 and 1.1.1 players and servers work together.

1.1.0

  • Added TargetPortal support. Mounts, carts and tames now come along when you pick a portal on TargetPortal's map (BringMount, BringCart, BringTames), and their cargo is gated there too. Supported portal mods are now XPortal and TargetPortal.
  • New minor version: the server and every player need 1.1.x.

1.0.2

  • Minor README fixes.

1.0.1

  • Minor README fixes.

1.0.0

Now BossGatedPortals Plus: still a portal progression mod first, with optional extras that are off by default. Same Thunderstore package, so it updates as usual.

Updating

  • Server owners: update the server and every player (players need 1.0.x).
  • The config file is now BarryWhite.BossGatedPortals.cfg. Your old file's settings are copied into it on first start, then carried over to the new setting names below; the old file is kept as BarryWhite.BossGatedPortals.cfg.before-1.0.0.

Progression

  • New installs unlock a tier for everyone once its boss is killed on the world (UnlockWhen = BossKilled). Existing servers keep their current rule.
  • The hint now says where the blocking item is when it isn't in your inventory: "in your Cart", "in Lox's saddlebags", "in your Explorer's Backpack" (new {where} in HintFormat; an unchanged hint text is updated automatically).
  • LogItemChecks now also warns about a tier missing the world key or boss item it needs (it would never unlock).
  • Inventory icons and tooltips are about three times faster: item names and unlocked tiers are looked up once instead of for every item, and Backpacks bag checks are a direct call instead of a slow lookup.
  • Saddlebags on tames the TeleportEverything 1.0 fork brings along are gated too. New startup warnings: the fork's Transport Ores (lets every item through), and ServersideQoL TameAssist's follower teleport (following tames' saddlebags skip the gate).

Optional extras (off by default)

  • [5 - Travel], each switched on separately:
    • BringMount: ride into a portal and your mount comes with you; you're put back in the saddle.
    • BringCart: a cart you're pulling comes with you and is hitched back to you.
    • BringTames: tames near you come with you. Choose which with the Tame… settings right under it: following you, named, or all tames, how far away, how many, which creatures, and whether summons come too. Tames following another player, or pulling a cart, never come.
    • A cart your horse pulls (OdinHorse) comes along with BringMount and BringCart both on, and is hitched back to the horse; with BringCart off it's unhitched and left behind.
    • Carts are always hitched back to whoever pulled them, even with other animals nearby.
    • Cart cargo and saddlebags follow the tiers like your own inventory, and a portal doesn't glow while they hold something locked.
    • Only through portals you walk into (vanilla and XPortal).
  • Steps aside for mods that already do the same job, with a line in the log: Travel while either TeleportEverything (Zenox's, or the 1.0 fork) is on; Portal Speed while QuickTeleport (OdinPlus or Muindor), FastTeleport or Proper Portals is installed.
  • [4 - Portal Speed], set to the game's own timings: FadeSeconds (default 1) sets how fast the screen fades when you step into a portal, down to 0 for instant; MinimumLoadingSeconds (default 8) sets the shortest loading screen, down to 0. Real loading time is never cut.

Shorter, regrouped config (your settings carry over automatically; the old lines are removed)

  • Sections: 1 General, 2 Item Rules, 3 Messages, 4 Portal Speed, 5 Travel, 6 Compatibility, 7 Admin, 8 Client.
  • RequireWorldKey and RequirePlayerBossItem became one choice, UnlockWhen: BossKilled, BossKilledAndDropHeld or DropHeld.
  • ShowUnlockHint is gone: an empty HintFormat turns the hint off.
  • GateAttachedCartCargo and GateTameCargo became GateCompanionCargo.
  • GateListedVanillaItems is now LockListedItemsAlways, with a clearer description.
  • ValidateItemIds and LogUnmappedItems became LogItemChecks; EnableStatusCommand is now StatusCommand.
  • LogPortalModDetection is gone: the XPortal version is always logged, and the AnyPortal warning is part of WarnOnConflictingMods.
  • RespectVanillaAllowAll moved to Item Rules; HintPosition and HintCooldownSeconds, the settings each player chooses, have their own Client section.

0.2.1

  • New GateTameCargo setting (on by default): when TeleportEverything, or Waypoints with "Teleport Tames" on, brings tames through with you, items in their saddlebags follow the tiers too (LoxSaddleBags, OdinHorse, or any container on a tame). Normal portals without those mods are unaffected.

0.2.0

  • Server owners: update the server and every player. Players need 0.2.x to join a 0.2.0 server, so nobody can keep using the backpack exploit below on an older version.
  • Fixed: ore in an AdventureBackpacks bag could go through portals before its boss was defeated. Bag contents now follow the tiers, and the hint names the right boss area.
  • Smoothbrain's Backpacks and RustyBags: items in their bags now unlock with their tiers. Before, they stayed blocked until the final tier.
  • The ServersideQoL warning now only appears for its PortalProgression add-on, not for every ServersideQoL part.
  • New startup warnings when another mod is set to let every item through: TeleportEverything (on by default), AzuMiscPatches, ValheimPlus, TargetPortal, Unified Target Portal, Portal Stations, Waypoints, Waystones, ReturnScroll, PortalRules (paid fares) and TeleportationMeads.
  • New log warning if a tier-listed item is teleportable anyway because another mod changed it.

0.1.4

  • Server owners: update the server first. From this version, players only need the same major.minor version as the server (any 0.1.x), so future bug-fix releases won't lock anyone out.
  • Safer against future Valheim updates: if an update makes part of the game private (what broke portals in 0.1.2), the mod keeps working instead of throwing errors.
  • Every hook now falls back to vanilla behaviour if something goes wrong, including the inventory icon, the unlock hint and the unlock announcement.
  • Better compatibility with other mods: the portal item check now runs after the game's own check instead of replacing it. No change in-game.
  • Small fixes from Valheim modding guidance: the config file is written once at startup, and the mod no longer unhooks itself when the game closes.

0.1.3

  • Fixed portals not working at all after the September 2026 Valheim update (the cart cargo check crashed).
  • Safer against future game updates: if a game change breaks one of the mod's hooks, that feature falls back to vanilla with an error in the log, instead of breaking portals, tooltips or the inventory.
  • Requires BepInExPack Valheim 5.4.2351.

0.1.2

  • Source code on GitHub (linked from the mod page and README). No gameplay changes.

0.1.1

  • Iron Pit unlocks in Swamp, Dvergr Extractor in Mistlands; Petrified Tissue and Bloodgold listed in Deep North.
  • New HildirChestsByTier setting (off by default): Hildir's chests never teleport unless enabled.

0.1.0

First release.

  • Teleport-blocked items unlock one tier per boss (world key + the player has held the boss drop).
  • The last tier (Deep North) unlocks everything; NeverTeleport list for permanent blocks.
  • Zone hints when a portal refuses you (never name a boss), with a per-player cooldown and position.
  • Tooltips and inventory icons show the real per-player teleport result.
  • Server-wide unlock announcements, admin-only portalgate status, optional AdminBypass.
  • Cart cargo gate for cart-teleport mods; conflict and XPortal/AnyPortal detection in the log.
  • Server-synced, admin-only settings; strict version check.