Communities

PEAK PingItems1.0.0

You are viewing a potentially older version of this package. View Latest Version

Install

Date Uploaded

11 months ago

Downloads

43K

Size

84KB

Dependency string

memiczny-PingItems-1.0.0

Download

Details Required (1)Versions

PingItems

A mod for PEAK that adds visual indicators when pinging near items in the game world.

Features

Visual Item Indicators: Colored reticles appear above items when pinged nearby
Player Color Integration: Indicators use the pinging player's color
Localized Item Names: Shows proper item names in your current language
Distance Information: Displays distance to items
Smooth Fade Effects: 5-second visibility with 1-second fade-out
Configurable Settings: Customize detection radius, visual effects, and more

Installation

Ensure you have BepInEx installed for PEAK
Download the latest release of PingItems
Extract PingItems.dll to your BepInEx/plugins folder
Launch PEAK

Configuration

The mod creates a configuration file at BepInEx/config/com.memiczny.peak.pingitems.cfg with the following options:

Display Settings

Duration: How long indicators remain visible (default: 5.0 seconds)
FadeOutDuration: Duration of fade-out animation (default: 1.0 seconds)
ReticleScale: Size multiplier for reticles (default: 6.0x)
LabelFontSize: Font size for item labels (default: 32)

Detection Settings

Radius: Maximum distance to detect items from ping (default: 8.0 units)
ShowDistance: Whether to show distance information (default: true)
ShowItemNames: Whether to show localized item names (default: true)

Visual Effects

EnableOutlines: Enable outline effects on text and reticles (default: true)
OutlineWidth: Width of text outline effect (default: 0.1)

How It Works

When you or another player creates a ping, the mod automatically detects nearby items
Visual indicators appear above detected items for the configured duration
Indicators show the item name, distance, and use the actual pinging player's color (works correctly in multiplayer!)
If the same item is pinged again during the display period, the timer resets
Indicators smoothly fade out after the display duration

Compatibility

PEAK Version: Compatible with current PEAK versions
Multiplayer: Fully supported - all players with the mod will see indicators in the correct pinging player's color
Performance: Optimized with object pooling and efficient detection algorithms

Troubleshooting

Indicators Not Appearing

Check that the detection radius is appropriate for your use case
Ensure items are within the detection range when pinging
Verify the mod is properly loaded in the BepInEx console

Visual Issues

Try adjusting the ReticleScale and LabelFontSize settings
Disable outlines if you experience rendering issues
Check the BepInEx console for any error messages

Performance Issues

Reduce the detection radius if you experience lag
Disable distance calculation or item names if needed

Development

This mod is built using:

BepInEx 5.x
Harmony for runtime patching
Unity UI system for visual elements

Building from Source

Clone the repository
Ensure you have the PEAK game references
Build using .NET Standard 2.1
The output DLL goes in BepInEx/plugins

Support

For issues, suggestions, or contributions:

Check the configuration options first
Review the BepInEx console for error messages
Ensure you're using compatible versions

License

This mod is released under the MIT License. See LICENSE file for details.

Changelog

Version 1.0.0

Initial release
Basic ping detection and highlighting
Player color integration
Configurable settings
Fade-out effects
Localized item names

Features

Visual Item Indicators: Colored reticles appear above items when pinged nearby

Player Color Integration: Indicators use the pinging player's color

Localized Item Names: Shows proper item names in your current language

Distance Information: Displays distance to items

Smooth Fade Effects: 5-second visibility with 1-second fade-out

Configurable Settings: Customize detection radius, visual effects, and more

Configuration

The mod creates a configuration file at BepInEx/config/com.memiczny.peak.pingitems.cfg with the following options:

Display Settings

Duration: How long indicators remain visible (default: 5.0 seconds)

FadeOutDuration: Duration of fade-out animation (default: 1.0 seconds)

ReticleScale: Size multiplier for reticles (default: 6.0x)

LabelFontSize: Font size for item labels (default: 32)

Detection Settings

Radius: Maximum distance to detect items from ping (default: 8.0 units)

ShowDistance: Whether to show distance information (default: true)

ShowItemNames: Whether to show localized item names (default: true)

Visual Effects

EnableOutlines: Enable outline effects on text and reticles (default: true)

OutlineWidth: Width of text outline effect (default: 0.1)

How It Works

When you or another player creates a ping, the mod automatically detects nearby items

Visual indicators appear above detected items for the configured duration

Indicators show the item name, distance, and use the actual pinging player's color (works correctly in multiplayer!)

If the same item is pinged again during the display period, the timer resets

Indicators smoothly fade out after the display duration

Troubleshooting

Indicators Not Appearing

Check that the detection radius is appropriate for your use case

Ensure items are within the detection range when pinging

Verify the mod is properly loaded in the BepInEx console

Visual Issues

Try adjusting the ReticleScale and LabelFontSize settings

Disable outlines if you experience rendering issues

Check the BepInEx console for any error messages

Performance Issues

Reduce the detection radius if you experience lag

Disable distance calculation or item names if needed