You are viewing a potentially older version of this package. View all versions.
larsbs-ScrollOfEscape-1.0.0 icon

ScrollOfEscape

Buy a Scroll of Escape from Haldor and read it to return to your bed. Follows portal rules for ore, has a 10 second channel and a 10 minute cooldown. All configurable and server-synced.

Date uploaded 4 days ago
Version 1.0.0
Download link larsbs-ScrollOfEscape-1.0.0.zip
Downloads 43
Dependency string larsbs-ScrollOfEscape-1.0.0

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.2360 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.2360

README

Scroll of Escape

Buy a Scroll of Escape and read it to return to your bed. A use for all those coins.

  • Haldor sells it for 100 coins, from the start. The price, the vendor and an optional boss-kill requirement are configurable. Crafting can be turned on instead or as well: a Workbench (level 2) recipe of 2 Feathers, 3 Greydwarf Eyes and 1 Surtling Core.
  • Read it from your inventory or hotbar. You kneel, a glow surrounds you, and 10 seconds later you vanish in a puff of smoke. While recalling you are held in place, so a bumped key cannot ruin it. Jump or read the scroll again to cancel. Taking damage interrupts the recall. Either way you keep the scroll.
  • The same rules as portals: you cannot carry ore or other items a portal refuses. Worlds with portals disabled block the scroll, and so does the "no portals during boss fights" world setting.
  • After a successful recall, you must wait 10 minutes before reading another. The timer shows on your HUD, counts real time, and is not reset by logging out or dying.
  • You need a bed set as your spawn point. If the bed was destroyed, you arrive where it stood and the spawn point is cleared, just like respawning.

Configuration

Edit BepInEx/config/local.valheim.scrollofescape.cfg, or use a configuration manager in game.

Setting Default Meaning
Vendor / Enabled true A vendor sells the scroll.
Vendor / Trader Haldor Who sells it: Haldor, Hildir or BogWitch.
Vendor / Price 100 Coins per scroll.
Vendor / RequiredKey empty World key needed before it is offered, such as defeated_eikthyr, defeated_gdking or defeated_bonemass. Empty sells it from the start.
Recipe / Enabled false The scroll can also be crafted.
Recipe / CraftingStation Workbench Where it is crafted; None crafts it from the inventory.
Recipe / StationLevel 2 Station level required.
Recipe / Requirements Feathers:2, GreydwarfEye:3, SurtlingCore:1 PrefabName:Amount pairs. An invalid list falls back to the default and logs a warning.
Recipe / Amount 1 Scrolls per craft.
Recall / ChannelSeconds 10 Time before teleporting; 0 teleports at once.
Recall / CooldownMinutes 10 Real-time wait between recalls; 0 disables it.
Recall / LockMovement true Holds you in place while recalling; jump or read again to cancel. When false, moving cancels instead.
Recall / CancelOnDamage true Taking damage interrupts the recall.
Recall / AllowInDungeons true Scrolls work inside dungeons and other interiors.
Effects / ChannelEffects fx_GP_Activation, vfx_Potion_eitr_minor Vanilla effects shown on you while recalling.
Effects / DepartEffects vfx_odin_despawn Vanilla effects where you vanish.
Effects / ChannelEmote kneel Emote when the recall starts; empty for none.

On a server, the server's Vendor, Recipe and Recall values apply to everyone, and only admins can change them. The Effects settings are cosmetic, and each player keeps their own.

Languages

English and Spanish (Español), following the game's language setting. Other languages show the English text.

Install

Install through your Valheim mod manager; Jotunn is installed automatically as a dependency.

For manual installation, install BepInEx 5 and Jotunn for Valheim, then copy BepInEx/plugins/ScrollOfEscape/ScrollOfEscape.dll into the matching folder of your game or mod-manager profile.

Multiplayer

Install the mod on every client and the server/host. Jotunn refuses joining when only one side has it or the versions differ, because players without it cannot see the scroll.

Uninstall

Scrolls in inventories and chests disappear when the mod is removed. Use or discard them first.

License

MIT. See the included LICENSE file. This is an unofficial Valheim mod and is not affiliated with Iron Gate.

CHANGELOG

Changelog

1.0.0

  • First release.
  • Scroll of Escape that teleports you to your bed, with an icon and model recolored from the game's own rolled hide.
  • Sold by Haldor for 100 coins. The vendor, price and an optional world-key requirement (such as a boss kill) are configurable, and an optional crafting recipe can be turned on.
  • Portal rules apply: no ore or other non-teleportable items, no use in worlds without portals, and the boss-fight portal block is respected.
  • 10 second channel: you kneel, a glow surrounds you, and you vanish in smoke. You are held in place while recalling; jump or read the scroll again to cancel. Damage interrupts it. The scroll is only used up when the teleport starts.
  • 10 minute real-time cooldown that survives logging out and dying, shown on the HUD.
  • English and Spanish text.
  • Configurable vendor, recipe, channel, cooldown and rules, synced from the server, and configurable effects.