ZenPortal

Portals Enhancement.

Designed to make portals into a rewarding experience. Reduce the over-use of them by keeping ships relevant but still being able to cross the world with portals when needed.

Extends the portal system to make it more immersive with improved QoL and balanced progression-based gameplay. Start with no portals. Unlock them as you adventure throughout the game. Highly configurable.

Full gamepad support. No more portal tags and typing required.

• Link portals using Runeshards which are collected from the Runestones found throughout the world.
• Fuel is required for portal activation. This means the portal is in the "off" state most of the time. No more falling in by accident. No more constant portal sound effects when you are standing near them. (Both ends are fueled simultaneously)
• The player becomes sick when they use a portal and receives a temporary debuff. (Configurable)
• Biome & Altitude restricted construction.
• Wood portals cannot connect to Stone portals and vice versa.
• Portals with no portal tag do not connect.
• Existing portals on existing worlds will still work.
• Backwards compatible, if the mod is removed, the portals will still work.

Option to invert the teleport item rules: Only allow items on the list to teleport, nothing else.

Advanced Admin Overrides

Normally the player will interact with all portals via the Runeshards mechanism. However, the admin may want to setup explicit portals that are always locked and can not be changed by the player. This is possible:

Explicitly set portal tags:

• Open the portal tag text editor by holding the left alt key while being in admin god mode when interacting with a portal.
• The tag text will be the portal tag name and display on the hover text.
• Hide name: Prefix with a . and the name will be hidden from the player's view.
• Prevent change: Suffix with ! and then the portal tag will be locked and cannot be changed by the player with a Runeshard.
• Letter case matters, so locked! is not the same as Locked!
• The tag name will be visible unless prefixed with dot: .hidden

Console commands:

• zen_portalrune Create a pair of Runeshards at your current position.
• zen_portalcure Remove portal sickness from yourself.

Extend Functionality with Additional ZenMods

• ZenHoverItem : View item icons when hovering over objects.
• ZenUseItem: Interact directly from your inventory without using your 1-8 hot bar.
• ZenMap: Perfect pairing with ZenPortal and ZenCompass for a low-map experience with limited access to navigation data.
• ZenSign: Assign items to signs and view the total available in nearby chests.

Improve Your Experience

CORE MODS

The full collection of all Zen MODS:

• Radically improved QoL
• Incredible performance
• Pre-configured
• 100% Gamepad support
• Spectacularly immersive

Enjoy!

Sample Config File:

## Settings file was created by plugin ZenPortal v0.1.0
## Plugin GUID: ZenDragon.ZenPortal

[Build - Cost]

## [Admin] Crafting station required to build the wood portal
# Setting type: String
# Default value: Workbench
# Acceptable values: None, Workbench, Forge, Stonecutter, Cauldron, ArtisanTable, BlackForge, GaldrTable, MeadKetill, FoodPreparationTable
Portal Wood - Station = Workbench

## [Admin] List of resources required to build a Wood Portal (Vanilla: GreydwarfEye:10, FineWood:20, SurtlingCore:2)
# Setting type: StringList
# Default value: GreydwarfEye:10, ElderBark:20, SurtlingCore:2
Portal Wood - Resources = GreydwarfEye:10, ElderBark:20, SurtlingCore:2

## [Admin] Crafting station required to build the stone portal
# Setting type: String
# Default value: Stonecutter
# Acceptable values: None, Workbench, Forge, Stonecutter, Cauldron, ArtisanTable, BlackForge, GaldrTable, MeadKetill, FoodPreparationTable
Portal Stone - Station = Stonecutter

## [Admin] List of resources required to build a Stone Portal (Vanilla: GreydwarfEye:10, Grausten:30, MoltenCore:2)
# Setting type: StringList
# Default value: GreydwarfEye:10, Grausten:30, MoltenCore:2
Portal Stone - Resources = GreydwarfEye:10, Grausten:30, MoltenCore:2

[Build - Restrictions]

## [Admin] Biomes which allow portals to be built. (Vanilla: All)
## [restart required for changes to take effect]
# Setting type: Biome
# Default value: Mountain
# Acceptable values: None, Meadows, Swamp, Mountain, BlackForest, Plains, AshLands, DeepNorth, Ocean, Mistlands, All
# Multiple values can be set at the same time by separating them with , (e.g. Debug, Warning)
Allow Biomes = Mountain

## [Admin] Minimum distance from any disallowed biome before a portal can be built.
## This prevents placing a portal just inside the edge of an allowed biome.
# Setting type: Int32
# Default value: 25
# Acceptable value range: From 0 to 100
Allow Biomes - Margin = 25

## [Admin] Only allow portals to be built above this altitude in the Meadows.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - Meadows = 0

## [Admin] Only allow portals to be built above this altitude in the BlackForest.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - BlackForest = 0

## [Admin] Only allow portals to be built above this altitude in the Swamp.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - Swamp = 0

## [Admin] Only allow portals to be built above this altitude in the Mountain.
# Setting type: Int32
# Default value: 150
# Acceptable value range: From 0 to 500
Min Altitude - Mountain = 150

## [Admin] Only allow portals to be built above this altitude in the Plains.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - Plains = 0

## [Admin] Only allow portals to be built above this altitude in the Mistlands.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - Mistlands = 0

## [Admin] Only allow portals to be built above this altitude in the AshLands.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - AshLands = 0

## [Admin] Only allow portals to be built above this altitude in the DeepNorth.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - DeepNorth = 0

## [Admin] Only allow portals to be built above this altitude in the Ocean.
# Setting type: Int32
# Default value: 0
# Acceptable value range: From 0 to 500
Min Altitude - Ocean = 0

[Portal - Fuel]

## [Admin] Prefab name of the fuel item for wood portals, leave blank for no fuel requirement
# Setting type: String
# Default value: BoneFragments
Wood Portal Fuel Item = BoneFragments

## [Admin] Prefab name of the fuel item for stone portals, leave blank for no fuel requirement
# Setting type: String
# Default value: CharredBone
Stone Portal Fuel Item = CharredBone

## [Admin] Max amount of units of fuel a portal can hold.
# Setting type: Int32
# Default value: 10
# Acceptable value range: From 1 to 60
Max Fuel (Minutes) = 10

[Portal - Sickness]

## [Admin] Vomit and lose all food after using a portal.
# Setting type: Boolean
# Default value: true
Puke On Use = true

## [Admin] If true then the player is unable to eat until portal sickness wears off.
## However, they can still drink meads and potions.
# Setting type: Boolean
# Default value: true
Puke On Eat = true

## [Admin] Can not teleport while portal sickness is in effect. 
## If false the portal sickness timer will be reset after each portal jump.
# Setting type: Boolean
# Default value: false
Prevent Teleport = false

## [Admin] Number of minutes that players will be sick after using a portal.
## Sleep will remove the sickness instantly.
## Set to 0 to disable portal sickness.
# Setting type: Int32
# Default value: 5
# Acceptable value range: From 0 to 120
Duration (Minutes) = 5

## [Admin] Movement speed adjustment when portal sickness is in effect.
## Set to 1 to for normal movement speed.
# Setting type: Single
# Default value: 0.8
# Acceptable value range: From 0 to 1
Debuff - Movement Speed = 0.8

## [Admin] Stamina regen multiplier when portal sickness is in effect.
## Set to 1 for normal regen rate.
# Setting type: Single
# Default value: 0.5
# Acceptable value range: From 0 to 1
Debuff - Stamina Regen = 0.5

## [Admin] Health regen multiplier when portal sickness is in effect.
## Set to 1 to for normal regen rate.
# Setting type: Single
# Default value: 0.5
# Acceptable value range: From 0 to 1
Debuff - Health Regen = 0.5

## [Admin] Health regen amount per tick when portal sickness is in effect. Negative numbers do harm.
## Because you can't eat when portal sickness is in effect, you can give small hp regen here.
## This will run for aproximately 10s whenever the player walks through a portal.
## Set to 0 to disable.
# Setting type: Single
# Default value: -0.5
# Acceptable value range: From -2 to 2
Debuff - Health Per Second = -0.5

[Portal - Travel]

## [Admin] Exclusive list of item prefab names that are allowed to be teleported.
## If any items are defined it inverts the vanilla behavior of restricting items.
## Instead, only allow teleporting the items listed, all others are restricted.
## If you want to deny all items use the keyword: NONE  (Vanilla: Leave blank)
## [restart required for changes to take effect]
# Setting type: StringList
# Default value: 
Exclusive Allow Items = 

## [Admin] Wood portals can only link to other wood portals, stone to stone. (Vanilla: false)
# Setting type: Boolean
# Default value: true
Same Type Only = true

[Rune - Colors]

## Portal rune's color when connected to another portal.
# Setting type: Color
# Default value: FFE300FF
Rune HoverText - Link Connected = FFE300FF

## Portal rune's color when pending a connection to another portal.
## NOTE: Clear means that it will fallback to the default color (white)
# Setting type: Color
# Default value: 00000000
Rune HoverText - Link Pending = 00000000

## Rune color when not in use in any portals.
# Setting type: Color
# Default value: FFE300FF
Rune HoverText - Link Available = FFE300FF

## Rune color when they are already connected to another portal somewhere in the world.
# Setting type: Color
# Default value: AAAAAAFF
Rune HoverText - Link Unavailable = AAAAAAFF

## Inventory item rune color when not in use in any portals
# Setting type: Color
# Default value: FFE300FF
Rune Inventory - Link Available = FFE300FF

## Inventory item rune color when in use by connected portals somewhere in the world
# Setting type: Color
# Default value: AAAAAAFF
Rune Inventory - Link Unavailable = AAAAAAFF

[Rune - Fracture]

## [Admin] Prefab name of the item that is required to fracture runestones.
# Setting type: String
# Default value: Obsidian
Fracture Item = Obsidian

## [Admin] The amount of "Fracture Item" required.
# Setting type: Int32
# Default value: 2
# Acceptable value range: From 1 to 100
Fracture Item - Amount = 2

## [Admin] Is the rune shard teleportable?
## [logout required for changes to take effect]
# Setting type: Boolean
# Default value: true
Rune Shard - Teleportable = true

## [Admin] The weight of a rune shard.
## [logout required for changes to take effect]
# Setting type: Single
# Default value: 2
# Acceptable value range: From 0.1 to 300
Rune Shard - Weight = 2

## [Admin] When this is on each runestone will create a different shard for each player.
## When this is off each runestone will create the same shard for every player.
# Setting type: Boolean
# Default value: true
Rune Shard - Per Player = true

Like My Mods? Donations Welcome

Bitcoin: bc1q34lrc82dp73jhv9ylefz0gvmeqfn96e938p4pf