lunarbin-Cross_Server_Portals icon

Cross Server Portals

Link your servers together with portals. Update portal tags and teleport directly between servers.

Last updated 3 months ago
Total downloads 2587
Total rating 5 
Categories Mods Server-side Client-side Utility Mistlands Update Transportation Hildir's Request Update Ashlands Update
Dependency string lunarbin-Cross_Server_Portals-0.3.0
Dependants 11 other packages depend on this package

README

Cross Server Portals

Connect your servers together with Cross-Server Portals.

Installation Guide

Add the CrossServerPortals.dll to your BepInEx/plugins folder on both client and server.

Usage

Update any portal's tag to the following format: SourceTag|Server:Port|TargetTag or SourceTag|world:WorldName|TargetTag

  • SourceTag: The Tag used to identify this portal.
  • TargetTag: The portal tag to search for when teleporting to the other server. If this tag is found either as a SourceTag or the full tag on a portal, you will come out through that portal. This feature only works if the mod is also installed on the server.
  • Server:Port: The Address/Hostname of the server and the port.
  • world:WorldName: world: followed by the name of the locally saved world.

Examples: homebase|127.0.0.1:2456|worldspawn bestbase|127.0.0.1:2460 stonehenge|127.0.0.1 worldspawn|world:HubWorld|riverbase

After updating the portal's tag, the portal will change color to indicate it is a cross-server portal. Going through the portal currently ignores all teleportation restrictions.

Configuration

PreserveStatusEffects - Defaults to true. Preserve status effects (such as wet, rested, etc.) when teleporting between servers. If the game is closed, the effects are lost. You must use a cross-server portal to preserve the status effect. RecolorPortalGlyphs - Toggles whether portal glyphs are recolored CustomPortalGlyphColor - The RGBA hex color code to use for portal glyphs RecolorPortalEffects - Toggles whether portal effects are recolored CustomPortalEffectColor - The RGBA hex color code to use for portal effects.

Planned Features

  • Prompt users before switching servers.
  • Validate Address:Port before making portal active.
  • Support for SinglePlayer worlds

Changelog

  • 0.3.0 - Improved support for Ashlands. Added configurable colors. Added support for single player worlds.
  • 0.2.1 - Updated packaged DLL
  • 0.2.0 - Added option (on by default) to preserve status effects across worlds.
  • 0.1.1 - Updated to work with Valheim v0.217.24
  • 0.1.0.0 - Initial Release