Project Zomboid

Project Zomboid

39 ratings
Location Identifier Framework
   
Award
Favorite
Favorited
Unfavorite
File Size
Posted
Updated
869.318 KB
30 Apr @ 1:28am
6 May @ 12:40pm
2 Change Notes ( view )

Subscribe to download
Location Identifier Framework

In 1 collection by Arendameth
Arendameth Mods
16 items
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
8 Comments
Comrade 8 May @ 11:51am 
i see you
Arendameth  [author] 6 May @ 8:14am 
@kirwu
Not really, the menu will be removed tonight with the update. Apologies if it gets in the way.
kirwu 6 May @ 8:08am 
bro is there an option to remove the menu when u start the game i already installed the mod bro
Arendameth  [author] 6 May @ 7:47am 
@Kazoo Commander
Immersive Lore doesn't require this mod yet, so it should definitely work alright. Can you check if the sandbox options are showing up?
Legion 4 May @ 6:53pm 
While I appreciate the heads up, I cannot get behind yet another mod adding a requirement that didn't have one before.
Kazoo Commander 4 May @ 4:32pm 
i have this activated, but immersive lore still doesn't work for some reason...
elijahhouck1102 30 Apr @ 6:09pm 
Thanks for the convenient heads up. Really useful for noobies to modding like me. A guy updated his mod once and it took me a whole day to find out whats going wrong where as a experienced person would have taken maybe 15 minutes lol.
khalkhedra 30 Apr @ 10:28am 
Immersive Lore update soon. Can't wait to see what's new. Now requires LIF I wonder why..