Configuration File

Here is the default config that ships with MV-NetherPortals with an explanation of each option.

Multiverse-NetherPortals Sample Config

####################################################################################################
#                                                                                                  #
#                         MULTIVERSE-NETHERPORTALS CONFIGURATION                                   #
#                                                                                                  #
#    WIKI:        https://mvplugins.org/netherportals/                                             #
#    DISCORD:     https://discord.gg/NZtfKky                                                       #
#    BUG REPORTS: https://github.com/Multiverse/Multiverse-NetherPortals/issues                    #
#    DONATE:      https://github.com/sponsors/Multiverse                                           #
#                                                                                                  #
#    New options are added to this file automatically. If you manually made changes                #
#    while your server is running, use Multiverse-Core's reload command.                           #
#                                                                                                  #
####################################################################################################
  
# Controls the prefix and suffix used to automatically find linked dimension worlds.
# For example, by default the world 'cat_nether' nether portal will be linked to world 'cat'.
portal-auto-link-when:
  nether:
    prefix: ''
    suffix: _nether
  end:
    prefix: ''
    suffix: _the_end
  
# When enabled, end portal exits from end world will override default behaviour and respawn players
# to the linked world's spawn. This is to handle the special case where player exiting end portal
# in end are treated as respawns instead of portal teleports in Minecraft.
# ** This feature is only supported on Paper servers.
handle-end-exit-respawn: true
  
# When enabled, players are pushed out of a portal when its destination is unavailable.
bounceback: true
  
# When enabled, non-player entities can travel through Nether and End portals.
teleport-entities: true
  
# When enabled, players are told when portals are disabled in the current world.
send-disabled-portal-message: true
  
# When enabled, players are told when a portal has no valid destination.
send-no-destination-message: true
  
# When enabled, blocks replaced while creating an End platform drop as items on non-default worlds to
# mimic vanilla Minecraft behaviour.
# Note: The default end is handled by the server and loaded even without Multiverse installed, thus
#       multiverse will have no control over it's drop items behaviour.
end-platform-drop-blocks: true
  
  
# The configuration version. Do not edit this value.
version: 5.1

Changes in 5.1

Multiverse-NetherPortals automatically migrates these older underscore-separated names when it loads the configuration:

Legacy links under worlds are imported into links.yml. The worlds section is no longer a Multiverse-NetherPortals configuration option.

Option Reference

portal-auto-link-when

Controls the naming convention used to automatically link portals between dimension worlds. Automatic linking is used only when the source world does not have an explicit link for that portal type.

portal-auto-link-when.nether.prefix

Default: '' (empty)

Text added before a base world name when looking for its Nether world.

portal-auto-link-when.nether.suffix

Default: _nether

Text added after a base world name when looking for its Nether world. With the default prefix and suffix, Nether portals in survival automatically lead to survival_nether, and Nether portals in survival_nether lead back to survival.

portal-auto-link-when.end.prefix

Default: '' (empty)

Text added before a base world name when looking for its End world.

portal-auto-link-when.end.suffix

Default: _the_end

Text added after a base world name when looking for its End world. With the default prefix and suffix, End portals in survival automatically lead to survival_the_end, and the End exit returns to survival when End-exit handling is enabled.

For example, use a nether_ prefix instead of the default suffix with:

portal-auto-link-when:
  nether:
    prefix: 'nether_'
    suffix: ''

handle-end-exit-respawn

Default for new configurations: true

Controls the special handling required when a player uses an End exit portal. Minecraft treats this as a respawn rather than a normal portal teleport. When enabled, Multiverse-NetherPortals sends the player to the spawn of the explicitly or automatically linked world, while preserving a valid bed or respawn-anchor destination where applicable.

bounceback

Default: true

When enabled, a player is physically pushed out of an unusable Nether portal—for example, when its explicit or automatic destination does not exist, or the player cannot enter the destination world. When disabled, the player is not pushed, but a portal without a valid destination still cannot teleport them.

teleport-entities

Default: true

When enabled, non-player entities such as mobs, boats, and minecarts can travel through Nether and End portals using the same world-linking rules. Set it to false to restrict NetherPortals teleportation to players.

send-disabled-portal-message

Default: true

When enabled, players are told when the current world's portal type has been disabled by explicitly linking the world to itself. Set it to false to suppress this message.

send-no-destination-message

Default: true

When enabled, players are told when a portal has no valid explicit or automatic destination. The message also identifies the automatically selected world that could not be found. Set it to false to suppress these messages.

end-platform-drop-blocks

Default: true

When enabled, blocks replaced while Multiverse-NetherPortals creates an End arrival platform in a non-default End world are dropped as items, matching vanilla behavior. Set it to false to replace those blocks without dropping them.

version

Current value: 5.1

Tracks the configuration format so Multiverse-NetherPortals can apply migrations. Do not edit this value.