Subscribe to download
Position Breakdown

This mod is a major reimagining of PositionXY by Mamka. Adds a useful overlay that includes info on your player's square (a.k.a. tile), cell, and chunk position, as well as the position of your tile in relation to your cell's origin (which is commonly nicknamed relative position).

The overlay has unique behavior when the world map is open! Mouse around (or move around with the gamepad) to see the breakdown of position information for any square on the map! Press X (while your world map is open) to copy the location under your mouse to your clipboard!

Position Breakdown is extremely customizable. Change the overlay's position, font size, font color, and opacity. Even choose one of five display modes:

Neat: Rectangular overlay in which lefthand and righthand elements are independently aligned.
Compact: Concise overlay in which each coordinate pair is presented on one line succinctly.
Abbreviated: Another compact overlay; abbreviates labels and drops parentheses to save space.
Verbose: A more vertically arranged overlay in which each coordinate is independently labeled.
Simplified: Also vertically oriented, but with simplified output and dropped parentheses.

Options can be activated using keyboard shortcuts, clickable buttons, and gamepad buttons. Keyboard and gamepad shortcuts can easily be turned on or off to minimize the need for rebinding. Please see below.

(Fully compatible with Dawn of the Zed, my mod for hiding your UI.)

A Note On Colors:

By default, buttons will have a rainbow theme for ease of telling them apart, and the overlay turns black for increased visibility whenever the world map is open. For those who strongly prefer to see one color all the time (on the buttons, in the map, et cetera), there are options in the config for accomplishing this. Please see the end of this description for info about the config file.

Toggling Option Shortcuts:

In order to reduce the odds of conflict with all other mods, I have included both keyboard and gamepad bindings for quickly disabling and enabling the mod's responses to either source of input.

On gamepad, you must triple-tap R1 (or Right Bumper), hold it, and then tap L1 (or Left Bumper). This complexity is to reduce the likelihood of accidentally enabling the action listeners for this mod on gamepad.

On keyboard, you must hold the right Ctrl key (not the left), hold F10, and strike F9.

Key and gamepad button combinations are used as shortcuts in this mod to reduce the keys needed for performing a wide range of useful functions. Please refer to the shortcuts below.

Additionally, you may move the overlay by clicking and dragging the sunset red button that appears when you are mousing near the overlay's origin point (which is near the top-left by default, or the top-right if you have moved the overlay to the right side of your screen and allowed it to automatically realign itself).

Clickable Buttons:

Color-coded buttons can be used to navigate many features of this mod (though not all). By default, these buttons are color-coded as follows:

Sunset Red:
Click and Drag: Move Overlay
Double-Click: Collapse or Expand Overlay

Orange:
Click: Cycle Through Levels of Detail

Yellow:
Click: Cycle Through Opacity Options

Green:
Click: Cycle Through Style Options (affects Font Size, Spacing, and Face)

Turquoise:
Click: Cycle Through Color Options

Blue:
Click: Cycle Through Display Modes

Violet:
Click: Toggle Automatic Alignment of the Overlay

White:
Click: Copy Location to Clipboard

Keyboard and Mouse Controls:

Note: Keyboard inputs are DISABLED by default in order to minimize interruptions for people adding this mod to existing servers. Turn them on by holding the right CTRL key, holding F10, and striking F9.

Key:

RC: Right Control
RA: Right Alt

Summary of Functions:

F9: Cycle Opacities
F10: Cycle Sizes
F9 (Hold) + F10: Toggle Visibility
RC: Cycle Modes
RC (Hold) + F9: Cycle Details
RC (Hold) + F10: Cycle Colors
RC (Hold) + RA: Toggle Automatic Alignment
RC (Hold) + F9 (Hold) + F10: Randomize Everything Except Position
RA + Move Mouse: Move Overlay

Summary of Keys:

Control: Display Mode and Alternate Action Access

F9: Opacity, Detail, and Alternate Action Access

F10: Size, Color, Toggle, Randomization

Right Alt: Overlay Movement and Automatic Alignment

Gamepad Inputs:

Note: Gamepad inputs are DISABLED by default in order to minimize interruptions for people adding this mod to existing servers. Turn them on by pressing R1 three times, holding it, and tapping L1 once.

Summary of Functions:

A: Cycle Opacities
B: Cycle Sizes
L1: Cycle Modes
L1 (Hold) + A: Cycle Details
L1 (Hold) + B: Cycle Colors
R1 (Hold) + A: Toggle Visibility
R1 (Hold) + B: Toggle Automatic Alignment
L1 (Hold) + R1 (Hold) + A: Randomize Everything Except Position
R1 (Hold) + L1: Cycle Overlay Movement Precision
R1 (Hold) + D-Pad: Move Overlay
R1 + R1 + R1 (Hold) + L1: Toggle Gamepad Shortcuts

Summary of Buttons:

L1 / Left Bumper: Alternate Action Access, Display Mode,
Shortcut Toggling, and Overlay Movement Precision

R1 / Right Bumper: Alternate Action Access, and Overlay Movement Activation

A Button: Opacity, Detail, and Randomization Button

B Button: Size, Color, and Alignment Button

D-Pad: Overlay Movement

Using Config File:

The first time you load this mod, it will create a config file called PositionBreakdown.ini in the Zomboid/Lua, which is located in your user directory on Windows. (Please do not confused the Zomboid directory with the ProjectZomboid directory. They are different.)

You may manually edit this config file if you so desire. There are a few options that are only available by editing this config, such as hiding buttons entirely, changing line labels, and changing the custom color.

IMPORTANT: If you accidentally edit your config file in a way that causes a misread of the file (e.g., by adding extra lines to the file, or misspelling a boolean, or adding a space to a boolean or numerical value), the file will automatically be overwritten with mod defaults. Please back-up your config file before editing it manually if you are concerned about this possibility.

I have included a README in this mod's main folder explaining how to edit PositionBreakdown.ini. All lines of the config file are described in detail. You can find it in Steam/steamapps/workshop/content/108600/2888465592 (for the uninitiated, this last number, the Workshop ID, is also in your URL right now).

Thanks again to Mamka of Position XY for the inspiration and many programming insights that make my version possible.

[ko-fi.com]

Workshop ID: 2888465592
Mod ID: PositionBreakdown