Mods / Multi Home Teleport /sethome /home /back /listhomes /homeinfo /delhome /tospawn /tp2p toplayer and teleport cost

Tags: #QoL
Author: MasterDeeJay
Side: Server
Created: Jul 8th at 8:36 AM
Last modified: Sep 12th at 9:36 AM
Downloads: 1958
Follow Unfollow 60

Latest release (for Vintage Story 1.21.1, potentially outdated):
MultiHomeTP_1.0.9.zip  1-click install


Teleport Mod — Commands & Configuration

 

Heads‑up: Player‑to‑Player teleport (TP2P) is new in v1.0.9. It should work, but please test it on your server.

 

A lightweight server‑side teleport system with homes, back, spawn, and TP2P. Optionally, teleports can cost “walk credit” that players earn automatically by moving around (walking/running/swimming). Costs scale with 3D distance and configurable multipliers and can be combined with cooldowns.

All persistent data is saved as JSON files in the mod’s data folder.


 

Commands

/sethome [name]

Save your current position as a home.

  • Default name is default if omitted.

  • Overwrites if a home with the same name already exists.

  • Single mode: only one home named default is allowed; any other name returns an error.


/home [name]

Teleport to a saved home.

  • Default name is default if omitted.

  • Has a cooldown (HomeCooldownSeconds).

  • If teleport costs are enabled and the target isn’t free, the cost is deducted from your walk credit (see Walk Credit & Costs).

  • Sets your previous position for /back.

  • Distance is calculated in full 3D (X, Y, Z).


/back

Return to your previous position (the spot you were at before your last /home or /tospawn).

  • Has its own cooldown (BackCooldownSeconds).

  • May cost walk credit if configured (see Walk Credit & Costs).

  • Only available if EnableBackCommand is true.


/listhomes

List all saved home names you own.


/homeinfo

Show the coordinates for all your saved homes.


/delhome <name>

Delete a specific home by name.

  • Single mode: only the default home can be deleted.


/delallhomes

Delete all your homes.


/renamehome <oldName> <newName>

Rename a saved home without moving it.

  • Single mode: renaming is disabled.


/tospawn, /tpspawn, /tptospawn

Teleport to the world’s default spawn position.

  • Has a cooldown (SpawnCooldownSeconds) if enabled.

  • May cost walk credit if configured (see Walk Credit & Costs).

  • Sets your previous position for /back.

  • Only available if EnableSpawnCommands is true.


/walkcredit

Display your current walk credit and a summary of the cost settings (global toggle and multipliers).


/listhomescost

From your current position, list for each home:

  • Approximate 3D distance in blocks,

  • Calculated teleport cost (given current multipliers),

  • Whether your current walk credit is sufficient.


Player‑to‑Player Teleport (TP2P) (v1.0.9 and up)

Availability: TP2P features are available only if EnableTP2P (tp2pEnabled) is true. TP2P may have its own cooldown and cost settings; distance is calculated in full 3D (X, Y, Z).

/tp2p <player>

Send a teleport request to the specified player.

  • The recipient must respond with /tpaccept <player> or /tpdeny <player>.

/tpaccept [player]

Accept a pending TP2P request from the specified sender and perform the teleport.

  • If teleport costs are enabled and this teleport isn’t free, the cost is deducted from your walk credit at acceptance time (see Walk Credit & Costs).

  • Sets your previous position for /back (so you can return to where you were before acceptance).

/tpdeny [player]

Deny a pending TP2P request from the specified sender.

/tp2pcost [player]

Show the TP2P teleport cost to the specified player; if omitted, shows the cost to all online players.


Walk Credit & Costs (optional system, 1.0.7 and up)

  • Walk credit is earned automatically as the player physically moves around the world (measured every WalkSampleIntervalMs).

  • Teleports can consume walk credit based on the 3D distance between the current position and the destination.

Master switch

  • TeleportCostEnabled (true/false) — enables the entire credit system.

Global base multiplier

  • TeleportCostMultiplier — applied to all teleport types that are not free.

Per‑command multipliers & free toggles

  • Home (non‑default): HomeTeleportMultiplier

  • Default home: DefaultHomeMultiplier, DefaultHomeFree (if true, /home default is free)

  • Back: BackTeleportMultiplier, BackTeleportFree

  • Spawn: SpawnTeleportMultiplier, SpawnTeleportFree

  • TP2P: TP2PTeleportMultiplier, TP2PTeleportFree

Cost formula

cost = distance_in_blocks × TeleportCostMultiplier × (per-command multiplier)
  • If a teleport is marked as free, its cost is 0 even if the system is enabled.

  • The mod prevents counting teleport jumps as “walked distance”.

Persistence

  • Walk credit is stored and periodically saved (WalkSaveIntervalMs, set ≤ 0 to disable periodic autosave).

  • On death, you can optionally reset walk credit to 0 (ResetWalkOnDeath) or lose a percentage (DeathWalkLossPercent). You can also suppress counting the first post‑respawn movement tick (SuppressRespawnTick) so respawn/teleport displacement doesn’t grant credit.


Configuration (file: MHT_config.json)

Note: Keys are case‑sensitive. Values shown below are examples—use the JSON at the end as a ready‑to‑paste sample.

Mode

  • TeleportMode: "multi" or "single".

    • multi: players can set multiple named homes.

    • single: only one home named default is allowed. On load, extra homes are collapsed into a single default home.

Cooldowns (seconds)

  • HomeCooldownSeconds — delay between /home uses.

  • BackCooldownSeconds — delay between /back uses.

  • SpawnCooldownSeconds — delay between /tospawn uses.

Feature toggles

  • EnableSpawnCommands — enable /tospawn, /tpspawn, /tptospawn.

  • EnableBackCommand — enable /back.

  • EnableTP2P — enable Player‑to‑Player Teleport commands (/tp2p, /tpaccept, /tpdeny, /tp2pcost).

Teleport cost system

  • TeleportCostEnabled — master on/off.

  • TeleportCostMultiplier — global base multiplier (e.g., 1.0 = full cost, 0.1 ≈ 10% of normal).

Per‑command cost settings

  • Back: BackTeleportFree, BackTeleportMultiplier

  • Default home: DefaultHomeFree, DefaultHomeMultiplier

  • Non‑default home: HomeTeleportMultiplier

  • Spawn: SpawnTeleportFree, SpawnTeleportMultiplier

  • TP2P: TP2PTeleportFree, TP2PTeleportMultiplier

Tip: If TeleportCostEnabled is true and the corresponding ...Free flag is false, the effective cost typically scales with:

TeleportCostMultiplier × <CommandSpecificMultiplier> × (distance-based factor)

Setting a command’s multiplier to 0 effectively makes that command free even if the global toggle is on.

TP2P settings

  • EnableTP2P — master toggle for TP2P.

  • TP2PTeleportFree — if true, accepting TP2P requests costs 0 walk credit.

  • TP2PTeleportMultiplier — TP2P‑specific multiplier (used with TeleportCostMultiplier).

  • TP2PRequestTimeoutSeconds — how long a TP2P request remains pending before expiring.

Limits

  • MaxHomes — maximum homes a player can have.

    • 0 or negative → unlimited.

    • In single mode, the effective maximum is always 1.

  • MaxWalkCredit — hard cap on accumulated walk credit.

Death & sampling behavior

  • ResetWalkOnDeath — if true, walk credit resets to 0 on death.

  • DeathWalkLossPercent — percent of current walk credit lost on death (if you’re using loss instead of full reset).

  • SuppressRespawnTick — if true, ignore the first movement sample after respawn (prevents counting the teleport/respawn displacement).

  • WalkSampleIntervalMs — how often to sample player movement. Enforced min 200 ms, max 60,000 ms. Lower values = smoother credit tracking but more server work.

  • WalkSaveIntervalMs — how often to autosave walk credit to MHT_walkprogress.json. 0 disables periodic save (credits will be lost on server restart).

Example configuration (paste into MHT_config.json)

{
  "TeleportMode": "multi",
  "HomeCooldownSeconds": 0,
  "BackCooldownSeconds": 0,
  "SpawnCooldownSeconds": 0,

  "EnableSpawnCommands": true,
  "EnableBackCommand": true,

  "TeleportCostEnabled": true,
  "TeleportCostMultiplier": 0.5,

  "EnableTP2P": true,
  "TP2PTeleportFree": false,
  "TP2PTeleportMultiplier": 1,
  "TP2PRequestTimeoutSeconds": 60,

  "BackTeleportFree": true,
  "BackTeleportMultiplier": 1,
  "DefaultHomeFree": false,
  "DefaultHomeMultiplier": 1,
  "HomeTeleportMultiplier": 1,
  "SpawnTeleportFree": false,
  "SpawnTeleportMultiplier": 1,

  "MaxHomes": 0,
  "MaxWalkCredit": 65536,

  "ResetWalkOnDeath": false,
  "DeathWalkLossPercent": 90,
  "SuppressRespawnTick": true,
  "WalkSampleIntervalMs": 1000,
  "WalkSaveIntervalMs": 30000
}

Data & Save Files

All files are stored under the mod’s data folder (e.g. …/TeleportMod/):

  • MHT_config.json — configuration (pretty‑printed JSON; saved atomically).

  • MHT_playerHomes.json — players’ homes (by UID and home name).

  • MHT_previousPositions.json — last pre‑teleport positions for /back.

  • MHT_walkprogress.json — players’ accumulated walk credit.

  • MHT_teleportmod.log — simple action log (teleports, deaths affecting credit, etc.).


Notes & Behavior Details

  • Distance is computed in 3D (sqrt(dx^2 + dy^2 + dz^2)) and rounded to the nearest block.

  • On /home and /tospawn, the mod records your previous position for /back. Other teleports outside this mod aren’t tracked.

  • After a teleport, the mod updates the internal “last known position” so the teleport itself does not generate walk credit.

  • In single mode:

    • Only default is valid for setting/using/deleting.

    • /renamehome is disabled.

    • On load, if multiple homes exist, they are collapsed to a single default entry (preferring an existing default, otherwise the first one found).

  • Costs and available commands respect the free/toggle flags in the config even when the global cost system is enabled.


Compatibility

Do not use together with:

  • “Simple Teleport to Spawn”

  • “Simple Home Teleport”

Running multiple teleport mods that manage homes/back/spawn in parallel can lead to conflicts or inconsistent player positions/credits.


Changelog & Future Plans

 

1.0.9

  • Added DeathWalkLossPercent and MaxWalkCredit, so players don’t lose all walk points; the maximum can be limited. Dont know where did it 
  • Added TP2P commands so you can teleport to other players (new feature — please test). Delete the config to generate a new one, or modify your existing file using the example above.

 

Future plans

  • Converting gears to teleport points.

Mod Version Mod IdentifierFor Game version Downloads Released Changelog Download 1-click mod install*
1.0.9 mutihometp 726 Sep 12th at 9:36 AM MultiHomeTP_1.0.9.zip 1-click install

added tp2p teleport to player, again this is a new feature so please delete the old config or modify it with the example

1.0.7 mutihometp 57 Sep 11th at 9:27 AM MultiHomeTP_1.0.7.zip 1-click install

added teleport cost, please delete the old config file, it will create a new one with much more options and better format!

1.0.6 mutihometp 277 Sep 3rd at 12:12 PM MultiHomeTP_1.0.6.zip 1-click install

added /tospawn (or /tpspawn, /tptospawn) command for teleporting to spawn, added cooldown, added extra configuration (delete the config file to recreate the new one) Do not use together with Simple Teleport to Spawn mod!

1.0.5 mutihometp 328 Aug 19th at 1:08 PM MultiHomeTP_1.0.5.zip 1-click install

added /delallhomes

1.0.4 mutihometp 257 Aug 19th at 1:08 PM MultiHomeTP_1.0.4.zip 1-click install

added /delallhomes

1.0.3 mutihometp 47 Aug 9th at 2:22 PM MultiHomeTP_1.0.3.zip 1-click install

added configurable teleport mode: single or multi (default)
so it can replace the my simplehometeleport mod

1.0.2 mutihometp 218 Aug 9th at 2:21 PM MultiHomeTP_1.0.2.zip 1-click install

added configurable teleport mode: single or multi (default)
so it can replace the my simplehometeleport mod

1.0.1 mutihometp 17 Aug 9th at 2:05 PM MultiHomeTP_1.0.1.zip 1-click install

test version 1.21 and .net8 compatible

1.0.0 mutihometp 25 Aug 9th at 2:03 PM MultiHomeTP_1.0.0.zip 1-click install

test version 1.20 and .net7 compatible


10 Comments (oldest first | newest first)

💬 Worker, Nov 25th at 6:22 PM

Is it possible to make separate home lists per world?  Or at least tag each home per world?  When I forget where I've been and /home to someplace from the previous world, I appreciate that teleporting into rock doesn't kill me but still it's a drag to wait five minutes before I can /home out again.

💬 neock, Oct 30th at 4:49 PM

this seems to need permissions to teleport. i dont know how to set the teleport permissions without setting people as admin..

 

💬 Nyarc, Sep 17th at 2:20 PM

Love the Idea of WalkCost
What about an Alternative System where it would Cost Temporal Gear / Rusty Gear instead? Would be cool.

💬 MasterDeeJay , Sep 11th at 9:29 AM

1.0.7 added optional teleport cost, it is now a more complex mod so i expect some bugs. Please delete the old MHT_config file, it will create a new one with much more options! 

💬 MasterDeeJay , Sep 3rd at 12:49 PM

Fefa

Thanks for the feedback!  I think i can solve it with somekind of /back command history.
As for TP/TPA: I’m planning to add /tptoplayer request or someting and then (/tpa, /tpaccept, /tpdeny) or someting. Not yet decided.

💬 Fefa, Aug 23rd at 12:20 PM

sweet, sorry for the late reply, for some reason my account wasnt logging automatically :D. So far working without any problem at all. Only weir thing i noticed is that i cant do back to return to a place where i did back. Like i am in point A use /back to go to Point B and then use /back to return to point A, it returns me to point B again. Not sure if its intended, but nothing that cant be solved, i just use many homes to return to places i want/need to return.

Do you have plans for a future to add a TP or TPA option? like request to teleport to a player or request a player to teleport to you?. if no plans for it i completely understand. Keep up the gread work and thanks a lot for this mod :)

💬 MasterDeeJay , Aug 18th at 5:40 PM (modified Aug 20th at 5:04 AM)

Fefa
added /delallhomes for the latest version,players can now delete their own saved homes.

if you want to delete all player homes delete %appdata%\VintagestoryData\TeleportMod folder 

💬 Fefa, Aug 18th at 5:49 AM

could you add an option to delete all homes? also noticed, when joining a new game hosted by my brother, if we change the world, the homes stay even if its a whole diferent brand new world, not sure if its intended or if i have to delete a file on my pc.

💬 MasterDeeJay , Aug 11th at 5:48 AM

whasit
Thanks for the feedback!

💬 whasit, Aug 11th at 2:16 AM (modified Aug 11th at 10:27 PM)

I'm on 1.20.12 and it all seems to be working well! I also changed the cooldown time in the config file and that also worked. (whoops had my version number backwards)

 (edit comment delete)
Основной веб-сайт | Почтовый сервер | FTP сервер | Административная панель | API интерфейс | Content Delivery Network | Статические файлы | Ресурсы сайта | Изображения | Файловое хранилище | Блог | Интернет-магазин | Техническая поддержка | Справочная система | Документация | Форум | Новости | Загрузки | Демонстрация | Тестовая среда | Приложение | Медиа контент | Разработка | Промежуточная среда | Бета версия | Безопасная зона | Вход в систему | Панель управления | Портал | Система управления контентом