SpikeHimself-XPortal icon

XPortal

Select portal destination from a list of existing portals. No more tag pairing, and no more portal hubs! XPortal is a complete rewrite of the popular mod AnyPortal.

Last updated 2 months ago
Total downloads 133582
Total rating 34 
Categories Mods Misc Utility Mistlands Update Hildir's Request Update Ashlands Update
Dependency string SpikeHimself-XPortal-1.2.21
Dependants 302 other packages depend on this package

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2200 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.2200
ValheimModding-Jotunn-2.20.0 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.20.0

README

XPortal

An AnyPortal revamp.

Description

XPortal lets you select a portal destination from a list of existing portals.

No more tag pairing, and no more portal hubs!

Features

Select a destination

When interacting with a portal, instead of entering a tag which has to match another portal's, XPortal lets you choose the portal's destination from a list. For your convenience, this list also shows you how far away the portals are.

Default destination

A Portal can be marked as the "Default Portal". When a Default Portal has been set, all newly built portals will immediately connect with that portal, without you having to go into the portal configuration panel.

Longer names

XPortal completely removes the character length restriction on portal names, so that you can give your portals clear and descriptive titles.

Ping a portal location

Forgot where you put your portal? You don't need to teleport to it to find out. Just click the Ping button next to the list, and XPortal will show the selected portal on your map, while also pinging its location to all players on the server.

If you prefer to play without a map, this button can be hidden, either by using the nomap global key, or by setting PingMapDisabled to True.

Multiplayer

XPortal has been built with multiplayer support at its core. All players must run the same version of XPortal. If you play on a dedicated server, that too needs to have same version of XPortal installed.

Gamepad support

The XPortal UI will respond to gamepad input when configuring your portal. As of v1.2.10 it even shows you the gamepad keyhints!

The controls are as follows:

  • A / Cross - Submit (i.e. press the OK button)
  • B/ Circle - Cancel
  • Y / Triangle - Ping the selected portal
  • X / Square - Show/hide the contents of the dropdown
  • D-Pad Up / D-Pad Down - Select the previous / next item in the dropdown

Mod compatibility and integration

XPortal has been made fully compatible with the following mods:

Furthermore, XPortal has a configuration option to fully integrate with Advanced Portals. If you set DisplayPortalColour to True, each portal in XPortal's dropdown list will be prepended by a ">>" tag that has the same colour as the light that the portal emits. As of v1.2.10, Stone Portals also get their own colour!

XPortal is known to be fully incompatible with:

Configuration

XPortal's config file, which can be found at Valheim\BepInEx\config\yay.spikehimself.xportal.cfg, contains the following settings:

PingMapDisabled

Disable the Ping Map button completely. For players who wish to play without a map. This setting is enforced (but not overwritten) by the server.

DisplayPortalColour

Show a coloured ">>" tag in the list of portals to indicate the portal type (integration with Advanced Portals and Stone Portal).

DoublePortalCosts

Since XPortal is essentially a cheat, in that you only need half the amount of portals now, this setting allows you to compensate for that by doubling portal costs. This setting is enforced (but not overwritten) by the server.

HidePortalDistance

If you don't want to see how far away the portals in the list are, you can use this option to remove that. This setting is enforced (but not overwritten) by the server.

DefaultPortal

This configuration option exists to save your personal Default Portal. Its value will be set by checking the Default Portal checkbox on the portal configuration panel. This value should not be manually edited in the file.

Installation instructions

XPortal is a BepInEx plugin. As such, you must have BepInEx installed. Most other Valheim mods are also BepInEx plugins, so chances are you already have this.

XPortal makes use of the Jotunn library, so you must install that before installing XPortal. If you do not install Jotunn, XPortal will simply not be loaded by your game and it will not work.

I very strongly recommend using a mod manager such as Vortex or r2modman. They will take care of everything for you and you don't have to worry about which files go where. I recommend against manual installation.

  1. Make sure you have BepInEx installed.
  2. Install Jotunn.
  3. On Nexus Mods click 'Mod manager download', or on Thunderstore click 'Install with Mod Manager'.

To install XPortal on a dedicated server, copy all of the contents of the plugins\ directory found inside the .zip file download to the Valheim\BepInEx\plugins\ directory on your server.

Bugs, Feature Requests and Translations

First of all, before you report a bug, please make sure that the problem you are experiencing is actually caused by XPortal. If you are running other mods, disable those, and see if the problem goes away. Or the other way around: disable XPortal, and see if that makes the problem go away. If you discover that XPortal is incompatible with another mod, please do report that, because I might be able to create work-arounds for that. If you are not sure, or you are struggling with these steps, then just report the problem, and we'll go from there.

It is important to me that I can make XPortal as bug-free as possible, but please bear in mind that without your LogOutput.log, I will not be able to debug your issue at all. Just showing me a screenshot of an error is not enough for me to discover the cause of that error.

To report a bug, please navigate to the Issues page, click New issue, choose Bug report, and fill out the template.

For feature requests, choose Feature request on the New issue page.

To add a translation to XPortal, choose Translation when submitting a New issue.

Credits

  • sweetgiorni for creating AnyPortal
  • kaiqueknup for translating to Brazillian Portuguese
  • makou for translating to French, Spanish
  • Smok3y97 for translating to German
  • MexExe for translating to Polish, Russian
  • hanawa07 for translating to Korean
  • bonesbro for adding a colour for Stone Portals (#39)
  • VasariRulez for translating to Italian
  • Felix for translating to Chinese

I did more too!

Please have a look at my other mod too! XStorage lets you open multiple chests at once, rename them, and move items/stacks to the most suitable chest.