Home Station Marker

An add-on for Elder Scrolls Online that draws 3D markers over crafting stations in a player home.



Adapted from Shinni's HarvestMap and Marify's Confirm Master Writ.

Originally written to help visitors find stations when crafting master writs with WritWorthy.

Follow development on GitHub

Export/Import: Finding stations in guild halls

Have a huge guild hall with hundreds of stations? You can now save a copy of your guild hall's station location list to Discord (or anywhere, it's just a text file). Then other players can import that location list to make it easier to find stations.

Guild Masters: /hsm export

1. Visit your guild hall and type /hsm export to get a dump of all the stations in your house.
2. Copy this text to a text file and store it on your guild's Discord server or pastebin or wherever.

Guild Members: /hsm import

To import a list of station locations, type /hsm import. This opens a window where you can paste the huge list of stations that you downloaded from your guild's discord server or wherever.

1. Download a list of stations from your guild. This is a text file on your guild's discord server or pastebin or somewhere. Ask your guild master for it. Point them to this page if they've never heard of HomeStationMarker.
2. Open the above text file and copy its contents to the clipboard.
3. In ESO, type /hsm import to make the HomeStationMarker Import window appear.
4. Paste text into the importer window
5. Click "Import" to add the results to your saved variables.

Libraries

Required Libraries:

• Shinni's Lib3d-v3

Optional Libraries, recommended:

• Baertram's LibSets
  Allows you to type /hsm Alessia cl instead of /hsm 82 2 for Alessia's Bulwark clothier station.

FAQ

Why don't I see any markers?

HomeStationMarker starts out not knowing any station locations. Once it has some station locations recorded to SavedVariables, it can show markers for those stations.

1. Run around the player house and interact with a few crafting stations, such as Enchanting or Armor Master Blacksmithing.
2. /hsm enchanting or /hsm armor bs to show the above marker.
   (This command requires Baertram's LibSets.)

In your own house, or any house in which you are trusted enough to have "Decorator" access, you can replace step 1 with /hsm scanlocs to immediately teach HomeStationMarker the location of every crafting station in the house.

Learning a station location after requesting a marker for it will not show a marker for that station. The marker will appear next time you enter the house or /reloadui.

Why are the markers not perfectly aligned with their stations?

When HomeStationMarker records a crafting station's location from you interacting with that station, HomeStationMarker actually records your player's position, not the crafting station's.

The API to learn a station's location is restricted to a house's owner or guests with "Decorator" access. For all other players, this is as close as I can get it.

Slash Commands

A few commands to help while testing, probably not useful to players:

/hsm <set> <station>

Toggle a marker above the given station. Can omit either argument.

• /hsm alchemy toggles a marker over an alchemy station
• /hsm alessia's blacksmithing toggles a marker over the Alessia's Bulwark blacksmithing station

This is mostly for testing/debugging this add-on. The simplistic string matching here was designed for, and tested on, EN English only. If it doesn't work in DE German, sorry.

Requires Baertram's LibSets

Crafting station abbreviations

Nobody wants to type "Jewelry Crafting Station".

• two-letters: bs, cl, ww, jw, al, en, pr
• first few letters: black, cloth, wood, jewel

Set abbreviations

• first few letters: alessia, twice-born, eternal
• tbs, nmg, juli, kags, seducer

Uppercase and punctuation ignored.

/hsm forgetlocs [all]

Forget all station locations for current house, or all houses if /hsm forgetlocs all. Use /hsm forgetlocs in a house after moving any crafting stations. Deletes all markers in current house (or all houses if /hsm forgetlocs all) as a necessary side effect.

/hsm scanlocs

Teach HomeStationMarker the location of every crafting station in this house.

Requires "Decorator" access, which you automatically have in your own houses, and rarely ever have in anybody else's house.

Not Supported

I have no desire to add these ever:

• custom markers
• colors
• per-add-on sets of markers

No thank you. That's an additional API and complexity that I don't want to spend my days supporting.

API

Why RefCount?

Reference counts free up other code from worrying about whether they need a station for two or more crafting requests, and whether the completion of a request means it is time to remove the marker or not. Let the refcounts do the worrying for you.

Ref counts also help if multiple add-ons use HomeStationMarker: what if WritWorthy needed a station, but some other add-on also needed that same station. If either one removed the marker, the other add-on's requested marker would end up lost.

RefCount/Marker Desync

The above 3 API functions are the only ones that touch or see the ref counts.
Slash commands such as /hsm <set> <station> bypass the ref count and toggle the marker regardless of API requests.

FPS Cost

Each marker slows down your frames per second.

This add-on also slows down frames per second while in player housing:

zo_callLater : a periodic task updates each marker rotation 8 times per second. Only registered within player housing.

EVENT_CRAFTING_STATION_INTERACT
EVENT_CLIENT_INTERACT_RESULT
EVENT_DYEING_STATION_INTERACT_START
EVENT_RETRAIT_STATION_INTERACT_START : Event listeners record station location each time you interact with a crafting station or assistant. This listener is only registered within player housing.

EVENT_PLAYER_ACTIVATED : An event listener hides all of a house's markers when you exit player housing, shows that house's previously hidden markers when you enter player housing.

Scene Listener : An event listener that shows/hides all markers when the HUD is shown/hidden while in player housing. Hides the markers when you're in the inventory/bank/dialog/whatever scene, unhides when you're back to walking around the house.

SavedVariables

• station locations: for each player house: each known crafting station's location