Location Identifier Framework

If you liked this item, please rate it up on Steam Workshop page.

Author: Arendameth

Last revision: 6 May, 2025 at 19:40 UTC

File size: 869.32 KB

On Steam Workshop

Description:
Description

Location Identifier Framework is a framework designed to help mods easily identify in-game world locations using coordinates. With LIF, you can retrieve structured and detailed information about any known map area, both vanilla and modded, by simply passing X and Y world coordinates.

Please note that this is a framework, not a standalone mod. It’s intended to be used by other mods that require detailed data of a certain location.

How It Works

LIF maintains a curated list of map regions, including both vanilla zones and areas added by supported map mods. On game start, LIF detects which mods are active and dynamically loads only the relevant location entries.

Usage Examples
local LIF = require("LIF") — Get location data from coordinates local loc = LIF.getLocation(5420, 9450) print(loc.shortName) — Outputs: Dixie — Get the current location of a player local playerLoc = LIF.getPlayerLocation(player) print(playerLoc.longName) — Outputs: Dixie, KY

Each location entry includes:

  • longName – Full name of the location (e.g., "Dixie, KY")
  • shortName – Abbreviated name (e.g., "Dixie")
  • id – A lowercase ID key (e.g., "dixie")
  • mod – The mod ID that added the location. If the location is vanilla, it will return "Vanilla"
  • isVanilla – Boolean flag for vanilla locations
  • startX/endX/startY/endY – Bounding coordinates

Compatibility
  • Other Mods – Should be fully compatible with all mods. Only interacts with coordinates and does not alter gameplay.
  • Game Version – Tested and works on 41.73+. Not tested on earlier versions.
  • Multiplayer – Functional in multiplayer
  • Pre-existing saves – Can be added to pre-existing saves.

Known Bugs/Issues
  • No known issues.

Links

Project page on github for documentation, list of locations, and possible contribution[github.com]
[discord.gg] – Join me on Discord
[ko-fi.com] – I love Coffee. Perhaps you’ll consider buying me one?

Feedback

Whether it is a suggestion, feedback, or something else you’ve got on mind, it’d be hugely appreciated!

Credits
  • This framework utilizes location data originally created by Braven in his mod "Where Am I", and has been extended to include additional metadata. Huge thanks to Braven for granting permission to build upon his work!

This mod’s permissions fall under TIS’s policy Ask for permission[theindiestone.com]

This mod can only be added to and extended with the express permission from the original creator. Having received permission, credit must be given to the original creator, both within the files of the mod and wherever the mod roams online.

If no permission is received you may not alter the mod, and it must be treated as a mod that is ‘On Lockdown’.

Workshop ID: 3473144811
Mod ID: LIF