Configuration - Sleepydragn1/Multiverse-TeleportFilter GitHub Wiki

options

All configuration entries under the "options:" header. Used to control various settings for the plugin itself.

enabled

• Default value: false
• Accepted values: true, false

Controls whether or not the plugin is enabled. True enables the plugin, while false disables the plugin. If the plugin is disabled, upon the server's startup, the plugin will be fully disabled and will not run in the background.

filter-disable

• Default value: false
• Accepted values: true, false

Controls whether or not the filter is enabled. True disables the filter, false enables the filter. If the filter is disabled, the plugin will remain running but the plugin will not enforce the filter on any Multiverse teleports. "/mvtpfenable" sets this value to false, while "/mvtpfdisable" sets it to true.

ignore-permissions:

• Default value: false
• Accepted values: true, false

If true, it ignores all Multiverse filter-related permissions (i.e. multiverse.teleportfilter.bypass and any specific filter-entry based permissions, but not command permissions like multiverse.teleportfilter.enable).

ignore-core-version-check

• Default value: false
• Accepted values: true, false

If true, it stops the plugin from checking the Multiverse-Core protocol version. The Multiverse-Core protocol version changes whenever there's a big change to the plugin, and as such the version check built into Multiverse-Filter normally disables the plugin if the protocol version changes to allow the developer to update it.

Setting this value to true allows you to run the plugin despite it being out of date and possibly incompatible with Multiverse-Core, but be warned: the plugin is not guaranteed to work properly or keep configuration files safe if it's out of date.

teleportfilter

All configuration entries under the "teleportfilter:" header. Used to configure the actual filter to work for various worlds and teleport entries.

Tutorial

Multiverse-TeleportFilter's filter configuration works as a blacklist, prohibiting all teleports specified while allowing any other teleport that doesn't fit any of the entries.

Entries require two bits of information about the teleport you're trying to block: the destination world of the player teleporting, and the origin world of the player teleporting, both of which are specified as the Multiverse aliases (see the Multiverse-Core Wiki page on aliases for more details) of those worlds.

The first sub-level of the "teleportfilter:" header specifies the destination and is formatted as the alias name with a colon at the end (i.e. a world named Adventure would be formatted as 'Adventure:'), while the sub-levels below that destination are a list that specifies the origin worlds that are blocked for that destination. Each origin world is formatted as the world's alias preceded by a dash (i.e. a world named Spawn would be formatted as '- Spawn').

The general format goes like this:

teleportfilter:
    [destination name]:
        - [origin name #1]
        - [origin name #2]
        - [origin name #3]
        - (etc. for any additional origin worlds)

For example, let's say that I wanted to block players from teleporting to the world "Adventure" from both "Spawn" and "Den". The configuration would look like this:

teleportfilter:
    Adventure:
        - Spawn
        - Den

If you want to block out all teleports to a specified destination world, using "all" or "wildcard" as an origin name will block all teleports to that destination.

For example, if I wanted to block teleports to Adventure from all possible origin worlds, the configuration would look like this:

teleportfilter:
    Adventure:
        - all

Defaults

The default configuration file can be found here.