CompassLocator 3.5.0 — Settings Help
Fabric 26.1.x

==================================================
1. GENERAL
==================================================

Language
Sets the language of the settings UI.
Options:
- Auto — uses the Minecraft language. If no translation exists, English is used.
- Русский
- English

Update period
How often the mod updates compass text.
Lower values update faster but may cause more load.
Typical values:
- 1–5 ticks — very frequent
- 10 ticks — normal
- 20 ticks — performance-friendly

Check both hands
If enabled, the mod checks both main hand and offhand.
Useful if the compass can be held in either hand.

Short directions
Uses short direction names:
- North → N
- South → S
- East → E
- West → W

Clear action bar
If no compass is held, the mod clears its last message.
Useful so old text does not remain visible.

Death reminder on join
Reminds the player that a saved death point exists when joining the world or server.

Refresh while moving
If enabled, the text updates not only on timer ticks but also when the player moves.

Coordinate decimals
How many decimal digits to show in coordinates.
Typical values:
- 0 — whole coordinates
- 1 — slightly more precise
- 2 — maximum UI precision

Message output
Where compass text is shown.
Options:
- actionbar — standard action bar
- overlay — separate text near the hotbar

Overlay Y position
Vertical offset of overlay output.
Lets you move the text higher or lower.

Overlay X offset
Horizontal offset of overlay output.

Line spacing
Spacing between overlay lines.
Useful if the text feels too cramped or too loose.

==================================================
2. NORMAL COMPASS / RECOVERY COMPASS
==================================================

Normal compass
Enables or disables the normal compass logic.

Recovery compass
Enables or disables the recovery compass logic.

Use lodestone target
If a normal compass is bound to a lodestone, the mod switches to lodestone mode.
Order in this mode:
1. player coordinates
2. lodestone coordinates

Keep after death
If enabled, the recovery compass is restored after death.
If disabled, it behaves normally.

Show coordinates
Adds coordinates to the normal compass text.

Show biome
Adds biome name to the normal compass text.

Show direction
Adds facing direction.

Show world
Adds the dimension/world name.

Show time of day
Adds a time-of-day label when supported by the current format.

Show death world
Adds the world where death happened.

Show death time
Adds elapsed time since death or a death time label.

Show death distance
Adds distance to the death point.
If the player is in another dimension, exact distance may be unavailable.

==================================================
3. FORMAT PRESETS
==================================================

Compass preset
Controls the overall display style of the normal compass.
Options:
- Classic — full and detailed
- Compact — shorter
- Minimal — shortest

Recovery preset
The same, but for the recovery compass.

Important:
Right now presets change the general text layout.
This is not yet a full manual editor for order/colors.

Dual separator
Separator between normal compass and recovery compass when dual mode is enabled.
Examples:
- |
- ║
- /

==================================================
4. DUAL MODE
==================================================

Dual mode
Allows showing normal compass info and recovery compass info at the same time.

Dual priority
Controls which text block is shown first:
- compass first
- recovery first

Dual: compass
If disabled, normal compass info is hidden in dual mode.

Dual: recovery
If disabled, recovery compass info is hidden in dual mode.

==================================================
5. LOCATOR BAR
==================================================

Locator bar
Enables locator bar support.

Visible range
Maximum range at which locator targets are considered visible.
Larger values show more but may add extra load.

Restore gamerule
If the mod changes the locator-bar gamerule temporarily, it restores the old value when disabled.

Force gamerule
The mod forces the required world gamerule for locator bar behavior.

Target requirement
Defines who can count as a locator target.
Options:
- everyone
- only players with a normal compass
- players with any compass

Refresh viewers
If a target state changes, the mod refreshes the locator for other players.

Equip delay
Delay after the player equips a compass.
Used for more stable updates.

Refresh delay
Delay for general locator refresh after target changes.

Unequip delay
Delay after the player removes a compass.

Final refresh
A final extra refresh after unequipping.
Prevents stale locator state.

==================================================
6. PROFILES
==================================================

Profile
Selected profile slot.
A profile is a saved set of the current mod settings.

State
Shows whether the selected profile already has saved data.

Save profile
Saves all current settings to the selected profile.

Load profile
Loads settings from the selected profile and applies them.

==================================================
7. BOTTOM BUTTONS
==================================================

Help
Opens the help folder inside the mod configuration.
This text file is stored there.

Reset all
Restores all settings to defaults.

Apply
Saves current settings to config.yml and applies them without closing the screen.

Close
Saves changes, applies them and closes the screen.

Esc
Acts like close with save if supported by the current build.
