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 all configuration options:

---

General Settings

Options controlling broad features of the mod.

Config Key	Default Value	Acceptable Values	Description
enableAllEffects	true	boolean	Master switch. If true, all visual/sound effects are enabled (respecting individual toggles). If false, major effects are disabled.

---

Particle Effects

Customize the visual particle displays during teleportation.

Config Key	Default Value	Acceptable Values	Description
enablePortalSpiral	true	boolean	Toggles the swirling portal particle effect.
portalSpiralCount	50	integer	Number of particles in the portal spiral.
spiralHeight	3.0	double	Maximum height (in blocks) of the particle spiral.
spiralRadius	1.5	double	Initial radius (in blocks) of the particle spiral.
enableOriginParticles	true	boolean	Toggles extra particles at the teleportation origin.
originParticles	30	integer	Number of extra particles at the origin.
enableDestinationParticles	true	boolean	Toggles extra particles at the teleportation destination.
destinationParticles	25	integer	Number of extra particles at the destination.
enableGroundCircle	true	boolean	Toggles the particle circle on the ground.
groundCirclePoints	20	integer	Number of points/clusters in the ground circle.
groundCircleRadius	2.0	double	Radius (in blocks) of the ground particle circle.

---

Sound Effects

Manage all sound effects associated with teleportation.

Config Key	Default Value	Acceptable Values	Description
enableMainTeleportSound	true	boolean	Toggles the primary Enderman-like teleport sound.
mainVolume	0.8	float	Volume of the main teleport sound (0.0 to 1.0+).
mainPitch	1.2	float	Pitch of the main teleport sound.
enablePortalTriggerSound	true	boolean	Toggles the secondary portal trigger sound.
portalVolume	0.5	float	Volume of the portal trigger sound.
portalPitch	0.8	float	Pitch of the portal trigger sound.
enableWhooshSound	true	boolean	Toggles the subtle "whoosh" sound effect.
whooshVolume	0.3	float	Volume of the whoosh sound.
whooshPitch	2.0	float	Pitch of the whoosh sound.
enableCoordinateTeleportSound	true	boolean	Toggles the specific sound effect for the /tpcoord command.
coordinateTeleportVolume	0.5	float	Volume for the /tpcoord sound.
coordinateTeleportPitch	1.5	float	Pitch for the /tpcoord sound.

---

Light Beam Effects

Controls the visual light beam effects.

Config Key	Default Value	Acceptable Values	Description
enableLightBeamEffect	true	boolean	Toggles the main vertical light beam effect for /tpr and /tphere.
maxHeight	8.0	double	Maximum height (in blocks) of the main light beam.
verticalSpacing	0.2	double	Spacing between particles in the main vertical beam.
beamRadius	0.3	double	Radius of the main light beam's border.
borderPoints	8	integer	Number of points on the circular border of the main beam.
topFireworks	15	integer	Number of firework particles at the top of the main beam.
enableSimpleEffectsForTpcoord	true	boolean	Toggles the more subtle particle effects for the /tpcoord command.
simplePortalParticles	16	integer	Number of particles in the simple portal circle for /tpcoord.
simplePortalRadius	1.0	double	Radius (in blocks) of the simple portal circle for /tpcoord.
simpleLightBeamHeight	4.0	double	Height (in blocks) of the simple light beam for /tpcoord.
simpleLightBeamSpacing	0.5	double	Spacing between particles in the simple vertical beam for /tpcoord.

---

Timing Settings

Adjusts the timing and delays of various effects.

Config Key	Default Value	Acceptable Values	Description
effectDelayMs	100	long	Delay (milliseconds) between origin and destination effects for /tpr, /tphere.
coordinateEffectDelayMs	50	long	Delay (milliseconds) for /tpcoord effects.

---

Permission Settings

Sets the required Minecraft permission levels for commands (0=Any Player, 1=Cheats, 2-4=OP Levels).

Config Key	Default Value	Acceptable Values	Description
tprPermissionLevel	0	integer (0-4)	Permission level for /tpr.
tpcoordPermissionLevel	0	integer (0-4)	Permission level for /tpcoord.
tpherePermissionLevel	2	integer (0-4)	Permission level for /tphere.
tplistPermissionLevel	0	integer (0-4)	Permission level for /tplist.
configReloadPermissionLevel	2	integer (0-4)	Permission level for /tpmodconfig reload.

---

Coordinate Validation Settings

Defines valid Y-coordinate (height) ranges for /tpcoord.

Config Key	Default Value	Acceptable Values	Description
minY	-64	integer	Minimum allowed Y-coordinate for teleportation.
maxY	320	integer	Maximum allowed Y-coordinate for teleportation.

---

Message Settings

Controls feedback messages sent to players.

Config Key	Default Value	Acceptable Values	Description
sendExecutorFeedback	true	boolean	If true, the command executor receives a confirmation message.
notifyTargetPlayerOnTpr	true	boolean	If true, the player teleported to (via /tpr) receives a notification.
notifyTargetPlayerOnTphere	true	boolean	If true, the player summoned (via /tphere) receives a notification.