Configuration File (tpmod.json)

The tpmod.json file allows for in-depth customization of the TeleportFX mod. It is automatically generated in your server or client's config folder the first time the mod is run.

You can edit this file manually. After making changes, you can reload the configuration in-game by using the command /tpmodconfig reload (this command requires the permission level specified in permissions.configReloadPermissionLevel, default is operator level 2).

Below is a breakdown of each section and its available options:

---

general

This section contains master switches for broad features of the mod.

Example:

"general": {
  "enableAllEffects": true
}



**particles**-Controls the various particle effects displayed during teleportation.

Example:

"particles": {
  "enablePortalSpiral": true,
  "portalSpiralCount": 50,
  "spiralHeight": 3.0,
  "spiralRadius": 1.5,
  "enableOriginParticles": true,
  "originParticles": 30,
  "enableDestinationParticles": true,
  "destinationParticles": 25,
  "enableGroundCircle": true,
  "groundCirclePoints": 20,
  "groundCircleRadius": 2.0
}

enablePortalSpiral (boolean): Toggles the swirling portal particle effect at the origin and destination points of a teleport. (Default: true)

portalSpiralCount (integer): The number of particles used to create the portal spiral effect. (Default: 50)

spiralHeight (double): The maximum height (in blocks) the particle spiral will reach. (Default: 3.0)

spiralRadius (double): The initial radius (in blocks) of the particle spiral. (Default: 1.5)

enableOriginParticles (boolean): Toggles extra particle effects (e.g., an end rod like burst) at the teleportation's starting point. (Default: true)

originParticles (integer): The number of extra particles to spawn at the origin. (Default: 30)

enableDestinationParticles (boolean): Toggles extra particle effects (e.g., falling obsidian tears) at the teleportation's arrival point. (Default: true)

destinationParticles (integer): The number of extra particles to spawn at the destination. (Default: 25)

enableGroundCircle (boolean): Toggles the display of a particle circle on the ground at both the origin and destination. (Default: true)

groundCirclePoints (integer): The number of distinct points or particle clusters forming the ground circle. (Default: 20)

groundCircleRadius (double): The radius (in blocks) of the particle circle on the ground. (Default: 2.0)




**sound**-Manages all sound effects associated with teleportation.

Example:

"sound": {
  "enableMainTeleportSound": true,
  "mainVolume": 0.8,
  "mainPitch": 1.2,
  "enablePortalTriggerSound": true,
  "portalVolume": 0.5,
  "portalPitch": 0.8,
  "enableWhooshSound": true,
  "whooshVolume": 0.3,
  "whooshPitch": 2.0,
  "enableCoordinateTeleportSound": true,
  "coordinateTeleportVolume": 0.5,
  "coordinateTeleportPitch": 1.5
}

enableMainTeleportSound (boolean): Toggles the primary Enderman-like teleport sound. (Default: true)

mainVolume (float): Sets the volume for the main teleport sound (0.0 to 1.0+). (Default: 0.8)

mainPitch (float): Sets the pitch for the main teleport sound. Higher values are more high-pitched. (Default: 1.2)

enablePortalTriggerSound (boolean): Toggles the secondary, lower-pitched portal trigger sound. (Default: true)

portalVolume (float): Sets the volume for the portal trigger sound. (Default: 0.5)

portalPitch (float): Sets the pitch for the portal trigger sound. (Default: 0.8)

enableWhooshSound (boolean): Toggles the subtle "whoosh" or elytra-like sound effect. (Default: true)

whooshVolume (float): Sets the volume for the whoosh sound. (Default: 0.3)

whooshPitch (float): Sets the pitch for the whoosh sound. (Default: 2.0)

enableCoordinateTeleportSound (boolean): Toggles the specific sound effect for the /tpcoord command. (Default: true)

coordinateTeleportVolume (float): Sets the volume for the /tpcoord sound. (Default: 0.5)

coordinateTeleportPitch (float): Sets the pitch for the /tpcoord sound. (Default: 1.5)



**lightBeam**-Controls the visual light beam effects.

Example:

"lightBeam": {
  "enableLightBeamEffect": true,
  "maxHeight": 8.0,
  "verticalSpacing": 0.2,
  "beamRadius": 0.3,
  "borderPoints": 8,
  "topFireworks": 15,
  "enableSimpleEffectsForTpcoord": true,
  "simplePortalParticles": 16,
  "simplePortalRadius": 1.0,
  "simpleLightBeamHeight": 4.0,
  "simpleLightBeamSpacing": 0.5
}

enableLightBeamEffect (boolean): Toggles the main vertical light beam effect for /tpr and /tphere commands. (Default: true)

maxHeight (double): The maximum height (in blocks) the main light beam will reach. (Default: 8.0)

verticalSpacing (double): The spacing between individual particles forming the main vertical beam. (Default: 0.2)

beamRadius (double): The radius of the main light beam's glowing border. (Default: 0.3)

borderPoints (integer): The number of points used to draw the circular border of the main beam. (Default: 8)

topFireworks (integer): The number of firework-like particles spawned at the top of the main light beam. (Default: 15)

enableSimpleEffectsForTpcoord (boolean): Toggles the more subtle particle effects specifically for the /tpcoord command. (Default: true)

simplePortalParticles (integer): The number of particles in the simpler portal circle for /tpcoord. (Default: 16)

simplePortalRadius (double): The radius (in blocks) of the simple portal circle for /tpcoord. (Default: 1.0)

simpleLightBeamHeight (double): The height (in blocks) of the simpler light beam for /tpcoord. (Default: 4.0)

simpleLightBeamSpacing (double): The spacing between particles in the simpler vertical beam for /tpcoord. (Default: 0.5)



**timing**-Adjusts the timing and delays of various effects.

Example:

"timing": {
  "effectDelayMs": 100,
  "coordinateEffectDelayMs": 50
}

effectDelayMs (long): The delay in milliseconds between the origin effect and the destination effect for /tpr and /tphere commands. (Default: 100)

coordinateEffectDelayMs (long): The delay in milliseconds for effects related to the /tpcoord command. (Default: 50)



**permissions**-Sets the required Minecraft permission levels for using each command.

0: Any player can use the command.

1: Players must have cheats enabled (single-player) or be an operator with at least level 1 permission.

2-4: Operator levels. Level 2 is typically required for most server management commands.

Example:

"permissions": {
  "tprPermissionLevel": 0,
  "tpcoordPermissionLevel": 0,
  "tpherePermissionLevel": 2,
  "tplistPermissionLevel": 0,
  "configReloadPermissionLevel": 2
}

tprPermissionLevel (integer): Permission level for /tpr. (Default: 0)

tpcoordPermissionLevel (integer): Permission level for /tpcoord. (Default: 0)

tpherePermissionLevel (integer): Permission level for /tphere. (Default: 2)

tplistPermissionLevel (integer): Permission level for /tplist. (Default: 0)

configReloadPermissionLevel (integer): Permission level for /tpmodconfig reload. (Default: 2)



coordinateValidation-Defines the valid Y-coordinate (height) range for the /tpcoord command to prevent teleporting into the void or excessively high.

Example:

"coordinateValidation": {
  "minY": -64,
  "maxY": 320
}

minY (integer): The minimum allowed Y-coordinate for teleportation. (Default: -64)

maxY (integer): The maximum allowed Y-coordinate for teleportation. (Default: 320)



**messages**-Controls the various feedback messages sent to players after command execution.

Example:

"messages": {
  "sendExecutorFeedback": true,
  "notifyTargetPlayerOnTpr": true,
  "notifyTargetPlayerOnTphere": true
}
sendExecutorFeedback (boolean): If true, the player who executes a teleport command will receive a confirmation message. (Default: true)

notifyTargetPlayerOnTpr (boolean): If true, the player being teleported to (when someone uses /tpr to go to them) will receive a notification. (Default: true)

notifyTargetPlayerOnTphere (boolean): If true, the player who is summoned (using /tphere) will receive a notification. (Default: true)