Personal Adjustable Waypoint 2.1.3 addon

PURPOSE:

Right-click on any marked location or NPC marker you can see on your PDA map, and track it as a task with a waypoint you can move or rename whenever you want. You can change both the name and the description of the waypoint, and your customizations are saved with your game.

Remove the waypoint whenever you want by right-clicking any visible icon on the PDA map. Anomaly will say a task has completed, but that's just a part of the task system--it means the waypoint is no longer active.

Label the map with pinned icons and notes so that you never forget where the dangers (or the good loot) are.

Don't let NPCs tell you where to go--be your own quest-giver. Put your PAW down and make the map yours.

If you're not already using a modpack with its own binaries such as GAMMA, get the latest modded exes from demonized here:

Github.com

PAW will work great without it, but a new feature in these binaries as of 2023-09-22 will let you leave your mark anywhere on Anomaly's map. See below in the "add your mark anywhere" section!

MAP PINS

You can right-click on any valid mapspot or other Point Of Interest and pin an icon of your choice to that spot, with a label that you can remove or rename at any time by right-clicking on it again. The icon of the new pin will be the currently-active icon chosen in MCM, in which you can choose from a variety of pin-style icons as well as faction badges, with more icon options on the way.

No, it's not as awesome as it sounds--it's better.

NEW IN 2.1: PIN SETTINGS WINDOW

Version 2.1 is a significant overhaul to pin management, introducing a new Pin Settings window that replaces the old dialogs used for naming and renaming, and introducing several new features!

• Icon customization sidebar for the Pin Settings window shows a custom version of the widget, with buttons to browse the icon library and apply the current icon to the pin.
• Mouse wheel will cycle icons or sets depending on what part of the settings window you're hovering.
• New interface sound for pin creation/editing - will obey PAW's MCM setting for UI sounds.
• Button in Pin Settings window to toggle UI sounds, controlling the above setting.
• Some context functions removed, as their functionality has been consolidated into one settings window or the other.
• New BWHR Stash Icon to go with the RGB customization; black-and-white icons can be made any color using the ARGB customization in the Pin Settings window.
• New Waypoint Settings window based on a simpler version of the Pin window: edit both name and description in one window, control other settings like HUD visibility.

NEW IN 2.1: MAP LABELS

Optionally show a visible caption on the map for any pin, letting you visibly label the map with any text you want--shown above with the "My special stash" example. Supports a variety of color and text substitutions:

$name: the name of the game object the pin is attached to.
$coord_x, $coord_y, $coord_z: replaced with the X/Y/Z map coordinate of the object at the time of label creation.
$clr_nnn: colors, where nnn is one of the following: wht (UI white), blk, red, grn, blu, yel, prp, orn (orange), lbl (light blue), 255 (fullbright white)

Unlike hover tooltips, these are always visible, and obscure less of the map behind them.

ALSO NEW IN 2.1

• New context option available when right-clicking on any vanilla stash icon: Convert to Pin and Customize. As the name suggests, this turns the stash icon into a persistent pin that you can customize (or show on the HUD) like any other.
• Added fade settings for the waypoint HUD marker, which work identically to the existing ones for pins.

QUICK PINS

Configure a hotkey of your choice in MCM (default: Apostrophe) to drop a Quick Pin at your location, with no further input required. Convenient if you've got to flee but don't want to forget the general area you were in, or are just moving quickly through an area but want to remember a place to come back to. You can always rename the pin later, or remove it and set one with a different icon using Cartography Mode--you don't have to even be on the same map to manage your pins!

Better still, if you have my Fair Fast Travel addon (also included in GAMMA 0.9.1 by default), it adds the ability to fast travel directly to any Quick Pins you place. It isn't allowed for manually-placed pins, because they can be anywhere--even out of map bounds. But Quick Pins are always, by their nature, placed in a spot where the player has been able to reach.

AUTOTAG AND SMART PINS

Do you like being able to "tag" enemies or other items of interest visually on your HUD? You can configure a hotkey of your choice to place a pin on whatever is under your crosshair, marking it on the HUD with your choice of icon.

If you've got too many keybinds already, Autotag has you covered. When enabled, hovering the reticle over a target for a short time will automatically tag it with an appropriate icon of your choice, depending on what kind of object it is. You can separately choose what icon (if any) to use for friendly, neutral, and enemy stalkers, as well as monsters and stash boxes. The identification part of this feature integrates with Crook's Faction ID addon, if installed--obeying its MCM settings for whether and how quickly targets must be identified.

If your reaction to this feature is more along the lines of "what in the Ubisoft is this shit?" don't worry--the feature is optional, and off by default. As usual, everything is customizable so that you can play your way.

ADD YOUR MARK ANYWHERE

It has always been impossible to interact with empty space in Anomaly's map--but if you have the latest modded binaries by demonized, that limitation is gone, and you can set pins or waypoints wherever you want!

You need to have at least a 2023.09.22 release of the modded exes, or newer. GAMMA also now supports this feature. Don't worry, PAW's normal functionality isn't going anywhere!

If this feature is enabled, a few new shortcuts are also available: Ctrl-Right-Click will instantly set or move your current waypoint to that spot, while Alt-Right-Click will create a new pin and open the settings window.

CARTOGRAPHY MODE AND PINGING THE MAP

But if you don't have the modded binaries, don't worry--Cartography Mode has you covered. Configure a hotkey of your choice in MCM (default: Slash) to enter Cartography Mode while you're in the PDA, which will highlight all smart terrain points in the entire Zone.

Smart terrain points arent secret data or anything--you can think of them like "navigation points", or just another kind of POI. NPCs are dumb, so Stalker's game engine uses these points for telling NPCs how to navigate from place to place in the world--but because they're in a list and we can know their exact location, we can use them as an "anchor" for your pins or waypoints.

Why does this matter? Because icons can only be attached to an object in the game for which you know the Story ID, and it's not possible to get the world coordinates at the mouse cursor in vanilla Anomaly. This means that the player's mouse can only interact with an object that is already visible on the map.

Cartography Mode makes all of these navigation points visible for as long as you hold it down, allowing you to set waypoints and pins virtually anywhere you like--or "ping" the map to display a grid of target markers around a known spot, so that you can more precisely choose your placement.

Some maps are dense with smarts, especially later maps like Jupiter and Zaton, while others like Cordon have (and need) relatively few. Pinging opens the entire map to you. Get creative!

INTEGRATION WITH MILSPEC PDA'S KILL TRACKER

If you have Milspec PDA 1.7.3 or later, you can use PAW to control what icons are shown on the map for body markers. You can either have it use the current default icon from the Body Markers set, or--if the victim is a Stalker--optionally have the body marker be their faction patch.

LTX-BASED ICON CUSTOMIZATION

Customize every set of icons available in the Pins menu, create your own, add favorites which will always be at the top, or even add your own icons from any valid mapspot texture as easily as editing a plain text file.

CUSTOM MENU OPTIONS

If you're comfortable editing PAW's menu_actions.ltx file, you can add your own context menu options that will always use a specific icon rather than the current default--for example, one which always shows up as a stash icon. Take a look at the "my_stash_icon" entry in menu_actions.ltx, it's quite straightforward. If you have MCM, you can more easily customize which options appear in your context menu.

MCM SUPPORT

PAW fully supports MCM for configuring its settings and keybinds--and there are a lot of them for you to play with! Feel free to clear any you don't want to use; they're all optional features.

INSTALLATION:

Install using a mod organizer. You can manually move them over from the Main folder if you're more comfortable doing that, but an organizer like MO2 is recommended. I can't support issues that occur with manual installations or JSGME.

If you are using GAMMA, EFP, Screen Space Shaders, the base demonized binaries, or any other modded executable files that support DXML, just install the base option, no patches. If and only if you are using the unmodified vanilla Anomaly files that don't support advanced features like DXML, only then should you install the "vanilla" patch in the FOMOD.

A new game is not required, and removing the mod will not affect a game in progess--however, you should cancel the waypoint task before uninstalling, otherwise you may encounter crashes or strange text in the PDA. The HUD markers or static map pins will not be re-drawn when you load your game if PAW is not installed.

If you wish to use the mouse wheel or right-click on empty space in the map, you'll need a version of the executables that has the necessary scripting support. You can get demonized's modded binaries here:

Github.com

UNINSTALLATION:

Use a mod organizer (recommended) or delete the files manually.

CONFLICTS:

If you have MCM installed, it must be at least version 1.6.5. Using older versions of MCM may cause crashes. You must update your MCM version to fix this.

If you are not using modded binaries of some kind(demonized, GAMMA, EFP, SSS, etc) that support DXML, and have installed the vanilla patch, this mod will conflict with any that modifies the following file:

configs\ui\map_spots_relations.xml

If at all possible, load PAW after any such addons. If not, these conflicts are easy to resolve manually. Instructions are included in the file. It should be fairly simple, but all of this is provided "as-is", and I cannot assist with troubleshooting merge issues.

Please just use modded binaries.

KNOWN ISSUES:

Some smart points related to monster spawning and other things might show up in cartography mode. I'm working on filtering those out as I find them, but you can turn off smart terrain spots altogether in MCM.

Some addons which trigger events based on tasks completing may trigger on the waypoint deactivation. To get around this, ask the author of the other addon to ignore the task_id "task_placeable_waypoint".

Localization may lag behind the current version. I'm always happy to include a copy of the xml file with localization in your language, if you're willing to provide one that is better than Google Translate or DeepL.

If you ever need to roll back to a previous version of one of my mods, a full version archive is here:
Github.com

CHANGE LOG

2.1.3: Fixed Autotag and reticle features, which had stopped working altogether for no well-explained reason.

2.1.2: Fixed unrecoverable state when changing maps after placing a Quick Pin but without modifying it. Fixed icon name changes not applying to tooltip. Unified most internal usages of pin.text versus pin.name. Removed harmless log spam from RefreshIcon and actor_on_stash_remove. Various bits of benign refactoring/code cleanup.

2.1.1: Disabled backpack icon customization feature until I can figure out why it conflicts with Hideout Furniture. If you have a customization, it will be preserved and restored when this feature returns. Updated RUS translation from leeviathan.

2.1: New pin and waypoint settings windows, allowing full ARGB and icon customization for any pin. Can now add visible labels to the map. Added Convert to Pin and customization of player stash icon features. Added fade settings for waypoints. Many bugfixes and internal changes.

2.0.2: Fix for crash when disabling PAW entirely in MCM. More robust code for said disabling function--it now unregisters all callbacks other than on_option_change (so that it can see if it changes back), and prevents all keybinds from working. It is essentially a killswitch for people who want to disable PAW in-game, but for some reason don't just uninstall it.

2.0.1: Updated RUS localization from leeviathan. Fix for possible crash when autotagging or setting pin persistence. Traps set to prevent similar hypothetical crashes. Pins won't change icon when renamed, correctly revert to old name when editing is canceled, and no longer leave an orphaned script_zone when initial naming is canceled.

2.0: PAW now uses DXML when supported. If you're using modded binaries, you no longer need a patch for Milspec PDA, GAMMA, or anything else modifying map_spots_relations.xml. Autotags are now temporary by default, and expire on new map or game load. Refactored autotag and waypoint display code paths to avoid race conditions. Cleaned up some unused code and content, temp logging, and comments. Various text updates.

1.16.3: For similar reasons to poltergeists, psy dog phantoms are also no longer valid tag targets--they can cause unpredictable crashes. Added a long-needed trap for when some other addon overwrites map_spots_relations. Instead of crashing when it tries to apply a missing mapspot, PAW will now catch this on first load, and disable itself--displaying a news tip to the player and adding information to the MCM menu about how to fix this.

1.16.2: Poltergeists are no longer valid tag/pin targets, as it isn't possible to avoid a crash when they die with a HUD pin. Fix for RUS text not appearing in HUD pin labels--the tiny font used for this doesn't support it, so when language is RUS, that font gets switched out for a slightly larger one that does. Refactored cart mode detection and cleaned up some commented-out code/logging. Updated RUS localization from leeviathan.

1.16.1: Fixed XML issue with RUS localization.

1.16: New Autotag and smart pin features allow automatic marking of targets with configurable pins. Fix for HUD markers being hidden on locked pins. Refactoring of reticle code, which has been moved to its own script.

1.15.1: Fix for possible crash when killing the last member of a squad while a waypoint is set on the squad itself (rather than on an individual NPC). Cleaned up various sources of event log spam. Adjusted waypoint HUD marker aspect ratio.

1.15: Identified issue cause as the Track monkeypatch added in 1.13, restored 1.13 code minus that piece. Finished overhaul of Widget menu with full-size preview of current theme. Fix for pins not being re-added to the map on savegame load (they're still there, just weren't visible). Fixes for pins not clearing on NPC death, debug logging re-enabling itself, and some MCM values being incorrect.

1.14: Rolled back to 1.12.2 code to resolve critical issue in GAMMA.

1.13: Added optional reticle for targeting valid pin/waypoint objects. Makeover of the widget position menu with preview using a miniature mock-up of 16:9 and 21:9 screens. Configure pins to fade in or out based on distance. Significant improvements to HUD icon scaling and positioning. Crash fixes related to nil value checks and body looting.

1.12.2: Fix for possible crash when skinning mutants.

1.12.1: Fix for pins not being removable from NPCs after death. Pins now auto-clear on death if placed on a living thing, and when looting a body with an attached pin.

1.12: New icon set for NPCs and services. Improvements to HUD icon handling. Added hotkeys to set waypoints and pins on the object under your crosshairs. New MCM options to support the new features, and significant MCM refactoring. Fix for quick pins defaulting to nearest smart instead of exact actor position.

1.11.1: Fixed a formatting error in the Russian localization file that prevented launching in that language. Sorry!

1.11: Improved clarity quality of waypoint HUD indicator, replaced image. Option to show distance and pin text on waypint/pin HUD indicators. Better aspect ratio correction for waypoint and pin HUD icons. Fix for waypoint indicator not disappearing, and for various edge-case crashes when a waypoint target despawns. Better name detection for stashes and NPC squads. PAW now warns the player if they try to use it with an NPC PDA equipped.

1.10.1: Fix to catch possible crash if MCM values got wiped out for any reason. Rebuilt MCM monkeypatch with improved parameters and functionality.

1.10: Fix for some edge-case crashes involving dead stalkers or objects with invalid ids. Snazzy new dynamic Pins menu in MCM with icon previews. Option for Cartography Mode as a toggle rather than a hold. Option to disable display of smart terrain spots in Cartography Mode. Some miscellaneous cleanup of log noise and unused variables.

1.9.1: Fix for possible crash when equipping an invalid PDA. Fix for waypoint HUD icon not disappearing when disabling it after it has been enabled. Fix for waypoint auto-clear not triggering if immediate MCM updates are disabled.

1.9: Right-click anywhere with the latest demonized exes. Ctrl-Rclick to set/move waypoint, Alt-Rclick to create and name a pin. Corrected aspect ratio of HUD icons. New text input window with current icon. Renaming and re-describing the waypoint now works as expected. Canceling out of the dialog will clear the current custom name/description. Temporary HUD markers are now removed when wiping all pin data. A truly staggering number of minor internal changes and fixes.

1.8: Added a visible HUD indicator for the waypoint target, can be disabled in MCM. Any pin can also be added to the HUD by right-clicking on it, but they are not on by default. Waypoint task text will now show the name of the target, and waypoint will auto-clear when player comes within a configurable distance.

1.7.5: Fix for unintended disabling of map ping functionality. Inclusion in GAMMA 0.9.1.

1.7.4: Adjusted update intervals to stagger them, and added hidden MCM keys to override these intervals. Added new menu options: Show and Hide All Pins. If any pins are active, one option or the other will appear, letting you toggle the visibility of all pins. Updated MCM options for context menus. Various internal changes.

1.7.3: Added an MCM option to disable the immediate MCM updates that occur when changing icons or sets during gameplay using keybinds or the mouse wheel. It's rare, but these updates can cause a perf hit on some machines. Some internal refactoring and unlocalizing.

1.7.2: Optimized the number of MCM update calls made in order to address possible lag spikes in GAMMA or when otherwise running a very large number of addons. Moved default location of GAMMA right-aligned widget theme up to avoid overlapping the lower-right compass. Changed internal ID of waypoint marker to avoid rare issues when setting a waypoint on top of an existing secondary task marker. Added override flags for mouse wheel support, and various other internal refactoring.

1.7.1: Fixed icon and set changes not syncing with MCM, and a handful of related issues. Fixed possible crash with HR Ecologist patch. Added RUS localization through 1.7 from Google Translate.

1.7: Added optional HUD indicator and mouse wheel support. Added keybinds for this, as well as for cycling sets and icons. Updated some MCM defaults.

1.6.1: New MPDA body marker icons, and fixes for body marker issues. You can now change name and desc for the waypoint; changes save and load with your game. Added MCM option to wipe pin data.

1.6: New icon set: Body Markers. Added option to control the body markers used for MilPDA's Kill Tracker. New icons for vanilla stash markers. Added code allowing users to add custom menu options that always use a specific icon for their pin. Added ability to rename the waypoint.

1.5: Ping the map to display a grid of markers in a radius so that you can more precisely place pins or waypoints. Quick Pins are now placed at the player's current exact location instead of the nearest smart terrain. Another fix for rep loss on task cancellation.

1.4.1: RUS localization provided by leevithan. No other changes in this hotfix.

1.4: Moved all icon and context menu definitions into LTX files for easy customization. Added partial RUS localization. FOMOD support. Fixed possible minor reputation loss on waypoint task cancellation.

1.3.1: Fixed MCM configuration of Cartography Mode keybind not working.

1.3: Many new features! Full MCM support, custom icons, waypoint toggle, map pins and quick pins, and more!

1.2: Fixed crash when loading a save with a placed waypoint. Loading a saved game that has this issue will trigger a safety catch that cancels the task. You can then save your game, and it will be fine after that.

1.1: Forgot to turn off debug logging before packing it up. Sorry about that! If your console is getting too much noise or you don't like the extra context menu stuff, download this hotfix. If you haven't noticed or don't care, there's no other functional difference.

1.0: Initial public release.