Skip to content

Configuration.creole

Latest commit

 

History

History
331 lines (171 loc) · 8.46 KB

Configuration.creole

File metadata and controls

331 lines (171 loc) · 8.46 KB
Raw

Abyss Configuration

Note: This document is typed using WikiCreole formatting.

This document describes the various configuration options supported by the Abyss plugin.

General

##auto-update##

  • Default: ##true##
  • Possible Values: ##false##, ##check##, ##true##

Whether or not Abyss should automatically check for and download updates. Set this to ##false## to disable checking for updates and downloading them, or to ##check## to merely inform you about available updates.

Note: You can still use the /abyss update command to check for updates.


##entity-type-whitelist##

A list of entity types that are allowed to go through portals to other worlds. Entity types are limited to prevent Abyss from destroying an entity that it can not correctly recreate after the teleportation. Hopefully, this won't be needed after Bukkit updates.


##use-metrics##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

When this is enabled, Abyss will submit usage data to MCStats.org. See: MCStats / Plugin Metrics


##use-multiverse##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

When this is enabled, Abyss will attempt to get world scaling information from Multiverse for calculating portal range, and world blacklists for determining valid destinations.


##use-worldguard##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

If Abyss is set to use WorldGuard, it will use WorldGuard to track portal locations and thus take advantage of WorldGuard's spatial tree for fast look-ups. Otherwise, or if WorldGuard is not available, Abyss will use a less efficient fallback class.


Portal Wand

##wand-name##

  • Default: ##Portal Wand##

The name of the Portal Wand item in-game. This string must be present in the display names of any items you wish to function as portal wands, and it will be used when creating a portal wand with the /abwand command.


##wand-material##

  • Default: ##STICK##
  • Possible Values: material

The base item to use for the Portal Wand. Make this something a player is not likely to frequently right-click with for best results.


##wand-range##

  • Default: ##256##

The maximum range of the Portal Wand. 256 is the maximum distance a player can see when they're using the Far viewing distance.


Portals

Default Network

##network-key##

  • Default: ##SKULL ITEM:3##
  • Possible Values: material[:data]

The default item to use as a portal's network, used for new portals or when a player left-clicks a portal's network frame.


##network-color##

  • Default: ##WHITE##
  • Possible Values: color

The default color for a newly created network.


Portal Dimensions

##minimum-depth##

  • Default: ##2##
  • Minimum Value: ##2##

The minimum depth required to create a portal.


##require-square##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

When this is true, created portals must be square unless created with a special wand or command with a specific size. This does not affect existing portals.


##minimum-size##

  • Default: ##2##
  • Minimum Value: ##2##

The minimum side length required to create a portal.

Note: You may also use ##minimum-size-x## and ##minimum-size-z##.


##maximum-size##

  • Default: ##4##

The maximum side length allowed when creating a portal without a special tool.

Note: You may also use ##maximum-size-x## and ##maximum-size-z##.


Effects

##use-portal-effect##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

Whether or not to create visual and audible effect when an entity passes through a portal.


##portal-effect##

  • Default: ##MOBSPAWNER FLAMES##

The visual effect to display when an entity is teleported through a portal. This may be given as just the name of the effect, or as the effect and a data value.


##portal-sound##

  • Default: ##ENDERMAN TELEPORT##

The sound effect to play when an entity is teleported through a portal. This may be given as just the name of the sound effect, or as the name, volume, and pitch.


##use-static-effect##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

Whether or not portals should have ambient effects in the world, shown at random time intervals.


##static-effect-centered##

  • Default: ##false##
  • Possible Values: ##true##, ##false##

Whether or not the static effect should be played at random positions, horizontally, within the portal. This leads to a more visually appealing effect.


##static-effect-full-height##

  • Default: ##true##
  • Possible Values: ##true, false##

Whether or not the static effect should be played throughout the entire height of the portal, or just at the very top.


##static-effect##

The visual effect to display at random intervals within a portal as ambiance. This defaults to ##portal-effect## if not given.


##static-sound##

Default:

static-sound: name: PORTAL volume: 0.2 pitch: 1

The sound effect to play at random intervals from a portal as ambiance.


Frames

##single-material##

  • Default: ##false##
  • Possible Values: ##true##, ##false##

If this is true, all blocks in a portal's frame must match.


##corner-depth##

  • Default: ##1##

Require at least ##corner-depth## layers of frame down to have corner blocks. If this is set to zero, then portals won't require corner blocks at all. By corner blocks, I refer to frame blocks not directly adjacent to the central shaft of the portal.


##frame-materials##

  • Default: ##[occluding]##

A list of materials that portal frames can be made of. Each entry in the list may be either the name of a block, the string ##solid## to match every solid block, or the string ##occluding## to match every occluding block. Additionally, you may prefix the name or string with a negative sign to instead remove the material from the list.


Velocity

##minimum-velocity##

  • Default: ##0.15##

The minimum velocity to allow for an entity leaving a portal. If an entity is not moving at least this fast, their velocity will be multiplied till it reaches this value.


##maximum-velocity##

  • Default: ##10##

The maximum velocity to allow for an entity leaving a portal. If an entity is moving faster than this, their velocity will be reduced down to this value.

Note: The default value is ##10## to prevent the "moved too quickly" anti-cheat protection from kicking in.


Configuration

##cooldown-ticks##

  • Default: ##40##

The amount of time, in ticks, that an entity is locked out from using the portal they arrived through upon their arrival somewhere. This is to prevent an entity falling immediately back in and being teleported away.


##maximum-modifiers##

The maximum number of modifiers allowed in a single portal. By default, this mirrors ##maximum-size## to create a full row of modifiers.


##smart-rails##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

When smart rails are enabled, rails placed around the top of a portal will have their behavior modified to make them connect to that portal, making it easier to send multiple rail lines through a single portal.


Distance Calculations

##limit-distance##

  • Default: ##true##
  • Possible Values: ##true##, ##false##

When this is true, a portal's destinations are limited to the portals within a certain range. This range varies depending on the ##base-range##, the depth of the portal, and any modifiers that increase range, such as the Ender Pearl and the Eye of Ender.


##base-range##

  • Default: ##50##

The base range of a portal. This is added to the portal's depth, multiplied by the ##depth-modifier## to determine how far a portal's range is. When determining if a destination is too far away, both the destination's range and the portal's range are taken into account.


##depth-multiplier##

  • Default: ##25##

The amount of range added for each block of depth the portal has.


Portal Modifiers

##slime-ball-strength##

  • Default: ##1.0##

The amount to increment a portal's velocity multiplier per slime ball modifier.