Free Teleport Anywhere

Map travel to any rung bell without a talisman, also next to a bell, with a Yes/No box. The game's other travel rules stay. A PBZModLoader mod.

  • MIT · open source
  • 0 stars
  • Latest release v1.0
  • Updated 4 days ago
  • Quality of life
Description

Free Teleport Anywhere

Map travel to any rung bell without a talisman, also next to a bell, with a Yes/No box. The game's other travel rules stay. A PBZModLoader mod.

What it does

Travel from the map to any bell you have rung, without a Traversal Talisman:

  • Free: no talisman needed, none used, no cost box.
  • Next to a bell too: the game refuses travel within 10 m of a bell; this mod does not.
  • A Yes/No box with the bell's name before you go (can be turned off).
  • After a checkpoint autosave, a rung bell in your region counts as your safe point, so you can travel from there.
  • Optional: travel also inside the game's no-travel zones, and during story sections that block it.

The game's other travel rules stay: not in combat, not in the air or swimming, not in a broken bell's state or the mirror world.

It is a PBZModLoader mod: a script in the game's own script engine. It replaces no game file and writes nothing into the save.

Screenshots

Free Teleport Anywhere

How to install

  1. Install PBZModLoader 2.1.0 or later.
  2. Download the zip of the latest release on GitHub (phantombladezero_freeteleportanywhere_<version>.zip).
  3. Unpack it into the game folder (the folder that holds ProjectPBZ). It adds the folder ProjectPBZ\PBZModLoader\mods\phantombladezero_freeteleportanywhere\ with main.js and the settings file.
  4. Start the game.

To check that it runs: ProjectPBZ\PBZModLoader\loader.log has the line [PBZMOD] [Free Teleport Anywhere] <version> started; settings: ....

To update the mod, replace main.js with the one of the new release; keep your settings file (a setting that it does not have keeps its default). To remove the mod, delete the folder ProjectPBZ\PBZModLoader\mods\phantombladezero_freeteleportanywhere\.

How to use

Open the map, pick a bell you have rung and confirm with Yes. Travel from a bell's own menu works as usual.

Settings

The settings are in ProjectPBZ\PBZModLoader\mods\phantombladezero_freeteleportanywhere\phantombladezero_freeteleportanywhere.txt. Open it with a text editor, change a value and save: the map takes it within 2 seconds, without a restart. Without the file the mod writes it with the defaults below. Keys are not case-sensitive; ; or # starts a comment.

With Mods Menu (0.9.0 or later) in the game, the mod adds its page to Mods Menu's tab in the game's settings, and the page's settings are the ones that count: Mods Menu keeps them in its own file in the game's Saved folder, and the file in the mod's folder is not read then.

Setting Default What it does
Enable On Off: the game's own travel rules
NeedTalisman Off Off: no Traversal Talisman needed or used. On: the game's talisman and its cost box
NearBell On On: travel also when you stand next to a bell
ConfirmBox On On: a Yes/No box with the bell's name. Off: travel at once. Only when no talisman is needed
IgnoreNoTravelZones Off On: travel also inside the game's no-travel zones
IgnoreStoryBlocks Off On: travel also during story sections that block it. Leaving one early can break a quest

Compatibility

  • Game version: Steam build 26367565 (CL-302256_JKS-17280).
  • Needs PBZModLoader 2.1.0 or later. Mods Menu is optional.
  • The earlier pak mods "Free Teleport", "Travel Anywhere" and "Free Teleport Anywhere" (a replaced Map.js): remove them first. This mod does all three, replaces no script, and works next to other map mods.
  • Another mod that changes the map's travel checks: this one wraps the game's methods, so both run; test them together.

Known issues

  • None known.

How to build

There is nothing to build: src\phantombladezero_freeteleportanywhere\ is the mod folder (main.js and the settings file). tests\test_mod.js runs the script outside the game with Node.js and stand-ins for the game: node tests\test_mod.js. README.md has the details.

Credits

Made by Kintaro. MIT license: you may use, change and share this mod. PBZModLoader is made by LKF, its fork by KintaroModding. Phantom Blade Zero and its files belong to their makers.