This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| teleportcommand [2026/01/10 18:24] – [What it does] mistahmikey | teleportcommand [2026/11/14 13:27] (current) – Update release summary, shared controls, support and full-window screenshots mistahmikey | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ======= Teleport Command (TC) ======= | + | ====== Teleport Command (TC) ====== |
| {{: | {{: | ||
| - | ===== What it does ===== | + | ===== Release Summary ===== |
| + | |||
| + | **TeleportCommand 2.0.0** | ||
| + | |||
| + | * Provides macro-friendly travel commands for maps, positions, worlds, housing plots, and Taximan favorites. | ||
| + | * Coordinates travel through MML, including housing transitions and the final destination position. Text Command Helper sequences can wait for arrival with wait=true and a timeout. | ||
| + | * Requires MML 6.0.0. Taximan is needed for favorites; other supported destinations do not require it. | ||
| + | |||
| + | ===== What it does ===== | ||
| Teleport Command (TC) provides a FFXIV macro command that will transport your character to chosen places all over Eorzea, even if they are on different worlds: | Teleport Command (TC) provides a FFXIV macro command that will transport your character to chosen places all over Eorzea, even if they are on different worlds: | ||
| Line 10: | Line 18: | ||
| * If you own Taximan, allows you travel to your favorite places. | * If you own Taximan, allows you travel to your favorite places. | ||
| - | TC only uses the in-game | + | TC uses normal |
| ===== Requirements ===== | ===== Requirements ===== | ||
| - | You must also download | + | Install the free MistahMikeysLib |
| + | |||
| + | Taximan is required only for its saved favorites. Other destinations do not require Taximan. Text Command Helper (TCH) is optional; install and enable the updated TCH if you want an alias sequence to wait for arrival. Ordinary chat commands and FFXIV macros can use TC without TCH. | ||
| TC supports the following languages: | TC supports the following languages: | ||
| Line 35: | Line 45: | ||
| TC can move your character to almost limitless places, but it cannot go to every possible location in the game. First and foremost, it is limited by the Minion Mesh system - if the location you wish to travel to is on a mesh, then TC has a good chance of getting to it. If it's not on the mesh, then TC cannot move to it - however, you can use the Minion mesh editing tool (the Navigation menu item on the Minion main menu) to fix such mesh deficiencies, | TC can move your character to almost limitless places, but it cannot go to every possible location in the game. First and foremost, it is limited by the Minion Mesh system - if the location you wish to travel to is on a mesh, then TC has a good chance of getting to it. If it's not on the mesh, then TC cannot move to it - however, you can use the Minion mesh editing tool (the Navigation menu item on the Minion main menu) to fix such mesh deficiencies, | ||
| - | ======= Command Description | + | ====== Command Description ====== |
| - | You must use the FFXIV echo command to submit a teleport command for execution, via a macro or typing | + | You must use the FFXIV echo command to submit a teleport command for execution, via a macro or typing |
| /e /teleport < | /e /teleport < | ||
| - | Each arg has the format <key>=<value>. White space is generally not significant EXCEPT when you specify values for which TC must search, like map names, world names, housing area names or Taximan | + | Separate arguments with commas. Most use '' |
| - | The teleport | + | The command |
| - | | Key | + | ^ Key ^ Value ^ Function |
| - | | worldid | + | | worldid | World number or world name | Select |
| - | | mapid | map number or map name | Used to specify | + | | mapid | Territory |
| - | | pos | world position | + | | pos | World X Y Z | Select a world position, with three numbers separated by spaces. World Y is height. These are not the X/Y coordinates printed on the in-game |
| - | | housingarea | + | | housingarea | Housing-area name | Select a housing area for plot travel. |
| - | | wardno | + | | wardno | Whole ward number | Select a ward in the chosen |
| - | | plotno | + | | plotno | Whole plot number, 1–60 |
| - | | favorite | + | | favorite | Saved favorite description | Requires |
| - | | flag | < | + | | favoritecat | Saved category name | Select the category containing '' |
| + | | flag | No value | Travel | ||
| + | | wait | true or false | In a TCH alias sequence, '' | ||
| + | | timeout | Positive finite milliseconds | Limit the entire trip, including intermediary routes, area transitions, | ||
| - | Any errors in command entry will result in a red message being displayed | + | Command-entry |
| + | |||
| + | Choose | ||
| Travel initiated by TC is affected by the settings on the Movement Tab, described below. | Travel initiated by TC is affected by the settings on the Movement Tab, described below. | ||
| Line 77: | Line 92: | ||
| - | ======= | + | ===== Travel Coordination, |
| + | MML manages one active trip across all participating addons. A new request while another trip is active is rejected; it is not queued and does not interrupt the current owner. This includes another request from TC itself. Wait for the existing trip to finish, or cancel it through the addon that started it, before retrying. | ||
| + | |||
| + | Resetting TC cancels its own active travel and resets its settings. It does not cancel travel owned by another addon. An already-issued teleport or area transition may still finish after cancellation; | ||
| + | |||
| + | During a normal Lua reload or unload, MML cancels owned travel and waits for its movement and transport to settle before allowing the reload or unload to complete. The next load starts without an active trip; previous travel and TCH command sequences are not resumed. Saved profiles and Taximan favorites are retained. | ||
| + | |||
| + | This coordination does not control unrelated addons that issue their own movement. Avoid running conflicting movement automation, such as another dungeon runner, at the same time. | ||
| + | |||
| + | ===== Command Examples ===== | ||
| + | Enter these in chat, or place them on ordinary FFXIV macro lines. Each line is an independent example: | ||
| + | |||
| + | <code text> | ||
| + | /e /teleport mapid=130 | ||
| + | /e /teleport mapid=134, | ||
| + | /e /teleport flag, | ||
| + | /e /teleport housingarea=Mist, | ||
| + | /e /teleport favorite=Zircon, | ||
| + | </ | ||
| + | |||
| + | The first example requests Ul'dah - Steps of Nald. The second requests Middle La Noscea with a two-minute limit. The housing example requests the placard at Mist, ward 1, plot 31 in the subdivision. The favorite example requires you to save a Taximan favorite named Zircon in the Default category first. Adjust destination names for your game language where applicable. Do not run several independent travel examples together: competing trips are rejected. | ||
| + | |||
| + | ===== Waiting for Arrival with Text Command Helper ===== | ||
| + | For completion-aware sequences, use MML 6.0.0, TeleportCommand 2.0.0, and Text Command Helper 2.0.0 together. Enable TC and TCH. Taximan is needed only for examples using its saved favorites. | ||
| + | |||
| + | In TCH, create an alias named '' | ||
| + | |||
| + | <code text> | ||
| + | /e /teleport favorite=Zircon, | ||
| + | </ | ||
| + | |||
| + | Create another alias named '' | ||
| + | |||
| + | <code text> | ||
| + | /e <lime Arrived at Zircon!> | ||
| + | </ | ||
| + | |||
| + | Then run: | ||
| + | |||
| + | <code text> | ||
| + | /e /exec visit_zircon, | ||
| + | </ | ||
| + | |||
| + | TCH waits for that exact trip to arrive successfully before running '' | ||
| + | |||
| + | To add a fixed 1.25-second pause after successful arrival, run: | ||
| + | |||
| + | <code text> | ||
| + | /e /exec visit_zircon, | ||
| + | </ | ||
| + | |||
| + | '' | ||
| + | |||
| + | The same arrival-wait options work without a favorite. For example, use either of these as the command of a TCH travel alias: | ||
| + | |||
| + | <code text> | ||
| + | /e /teleport flag, | ||
| + | /e /teleport housingarea=Mist, | ||
| + | </ | ||
| + | |||
| + | Follow that alias with a separate success-message alias in ''/ | ||
| + | |||
| + | If TeleportCommand is missing or disabled, the updated TCH reports the problem and stops the sequence even when '' | ||
| + | |||
| + | ====== UI ====== | ||
| + | |||
| + | The descriptions reflect the current release. Some screenshots show earlier layouts or English labels; the text describes the current controls. | ||
| You start TC via the FFXIVMinion menu drop down. It's under the " | You start TC via the FFXIVMinion menu drop down. It's under the " | ||
| Line 92: | Line 173: | ||
| | Enabled* | When checked, enables you to travel to specified locations by issue a macro command.| | | Enabled* | When checked, enables you to travel to specified locations by issue a macro command.| | ||
| - | | Reset | Resets all settings to their default | + | | Reset | Cancels TC's own active trip and resets its settings to their initial values. |
| | Discord Icon | Takes you to the TC Discord channel if you need support. | | Discord Icon | Takes you to the TC Discord channel if you need support. | ||
| | My Position | Shows you the current real world position of your character as < | | My Position | Shows you the current real world position of your character as < | ||
| ===== Movement Tab ===== | ===== Movement Tab ===== | ||
| - | {{: | + | {{: |
| - | The Movement Tab allows you to control what kind of movement speed will be used to move your character within the zones TC visits. | + | The Movement Tab allows you to control what kind of movement speed will be used to move your character within the zones TC visits. |
| + | |||
| + | | Enable Speed Actions | When checked, TC will attempt to use speed actions (Sprint or Peloton) whenever they are available and it is appropriate. The mount will take priority if the cutoff distance requirement is met. | | ||
| + | | Speed Action Cutoff Distance (yalms) | The distance above which TC will use Speed Actions to move your character. | | ||
| + | | Enable Mount | When checked, TC will attempt to use a mount whenever one is available and it is appropriate. | | ||
| + | | Mount Cutoff Distance (yalms) | The distance above which TC will use a mount to move your character. | | ||
| + | | Mount Selection | A list of mounts from which you can chose one to use whenever a mount is needed to travel to the destination. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. | | ||
| + | | Select Random Mount | When checked, TC will randomly pick an available mount that you own to travel to the destination. This overrides your Mount Selection. | | ||
| - | | Enable Speed Actions* | When checked, TC will attempt to use speed actions (Sprint, Peloton, Fists of Wind) whenever they are available and it is appropriate. The mount will take priority if the cutoff distance requirement is met. | | ||
| - | | Speed Action Cutoff Distance (yalms)* | The distance above which TC will use Speed Actions to move your character. | | ||
| - | | Enable Mount* | When checked, TC will attempt to use a mount whenever one is available and it is appropriate. | | ||
| - | | Mount Cutoff Distance (yalms)* | The distance above which TC will use a mount to move your character. | | ||
| - | | Mount Selection* | A list of mounts from which you can chose one to use whenever a mount is needed to run that long distance to the placard. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. | | ||
| - | | Select Random Mount* | When checked, TC will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection. | | ||
| ===== Profile Tab ===== | ===== Profile Tab ===== | ||
| - | {{: | + | {{: |
| - | The Profile Tab allows you to persistently store most of TC' | + | The Display Language choice on Debug is saved with this addon' |
| - | | Load Current Profile After Reset* | When checked, if you hit Reset on the Main Tab, or when TC is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded. | | + | The Profile Tab allows you to persistently store most of TC's settings. The profile settings are stored in files unique to the character and game region used to create the profile. You can create as many profiles as you like. The controls on this tab are: |
| - | | Current Profile Name* | The settings file you selected to be the current profile being used by TC. | | + | |
| + | | Load Current Profile After Reset | When checked, if you hit Reset on the Main Tab, or when TC is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded. | | ||
| + | | Current Profile Name | The settings file you selected to be the current profile being used by TC. | | ||
| | Load | Load all settings from the current profile. | | | Load | Load all settings from the current profile. | | ||
| | Save | Save all settings to the current profile. | | | Save | Save all settings to the current profile. | | ||
| Line 119: | Line 203: | ||
| | Add | Create the new profile and save all current settings to it. | | | Add | Create the new profile and save all current settings to it. | | ||
| - | The table is a list of all the profiles you have created for the current character and game language. Using the " | + | The table is a list of all the profiles you have created for the current character and game region. Using the " |
| ===== Debug Tab ===== | ===== Debug Tab ===== | ||
| + | {{: | ||
| - | {{:mistahmikey: | + | This tab is primarily intended for use in conjunction with consultation with support. |
| - | This tab is primarily intended for use in conjunction with consultation with TC support. It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during Squatter' | + | Changing Display Language refreshes presentation without resetting active work. It does not change game text, interaction matching, command destination names, or region-based profile selection. Some screenshots show earlier |
| - | | Enable Log file* | When checked, | + | | Display Language | Choose Automatic (Game Language), English, French, Japanese, Chinese (Simplified), |
| - | | Enable Timestamp* | When checked, | + | | Enable Log File | When checked, a unique log file will be created |
| - | | Debug Message Level Settings* | TC' | + | | Enable Timestamp | When checked, the current tick count will be included |
| + | | Debug Message Level Settings | The debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity. | ||
| + | | Enable Async Logging | When checked, log output for periodic writing is buffered. | | ||
| + | | Log Flush Interval (ms) | Shown when async logging is enabled; sets the buffer flush interval in milliseconds. | | ||
| + | | Cleanup Log Files | When clicked, runs the library' | ||
| - | ====== Support ====== | + | Additional tracing and diagnostic panels may appear when authorized by the library. Use these with support guidance. |
| + | ====== Support ====== | ||
| For bug support, please post a message on discord: https:// | For bug support, please post a message on discord: https:// | ||
| Line 139: | Line 228: | ||
| - Enable the debug information category on the Debug Tab and do what you did to create the problem. | - Enable the debug information category on the Debug Tab and do what you did to create the problem. | ||
| - | - A screen shot of your Material Girl main tab | + | - A screenshot |
| If you post this information to the specified channel (NOT RECOMMENDED), | If you post this information to the specified channel (NOT RECOMMENDED), | ||
| Additionally, | Additionally, | ||
| - | If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. | + | If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. |