# ❤️ HealthIndicator

It can be used to spoof or hide player health, absorption, and XP metadata depending on your configuration.

{% hint style="warning" %}
This module requires PacketEvents.

Install PacketEvents on the Velocity proxy before enabling HealthIndicator.
{% endhint %}

***

### What It Does

The HealthIndicator module provides packet-based control over visible player metadata.

It can be used for:

* Hiding player health indicators
* Spoofing player health metadata
* Hiding or modifying absorption display
* Hiding or modifying XP metadata
* Preventing certain client-side health information from being visible
* Bypass-based exclusions for trusted players or staff

***

### When To Enable It

Enable this module if your network needs packet-level control over health-related player information.

This module is useful for:

* PvP networks
* Competitive servers
* Minigame networks
* Servers that want to hide health information
* Servers that want to control how health, absorption, or XP metadata appears to players

***

### Requirements

HealthIndicator requires PacketEvents.

| Dependency     | Required | Purpose                                                                 |
| -------------- | -------- | ----------------------------------------------------------------------- |
| PacketEvents   | Yes      | Required for packet-based health, absorption, and XP metadata handling. |
| Redis          | No       | Not required.                                                           |
| MySQL          | No       | Not required.                                                           |
| MongoDB        | No       | Not required.                                                           |
| Discord        | No       | Not required.                                                           |
| PlaceholderAPI | No       | Not required.                                                           |

{% hint style="danger" %}
HealthIndicator will not work correctly without PacketEvents installed and loaded on the proxy.
{% endhint %}

***

### Configuration File

The HealthIndicator module configuration file is located at:

```
plugins/NexusProxy/modules/healthindicator/healthindicator.yml
```

This file can contain settings for:

* Module status
* Health metadata behavior
* Absorption metadata behavior
* XP metadata behavior
* Bypass permission behavior
* Messages
* Packet handling options

***

### Default Commands

The HealthIndicator module does not provide default player commands.

It is controlled through its configuration file:

```
plugins/NexusProxy/modules/healthindicator/healthindicator.yml
```

***

### Permissions

| Permission                          | Description                                                                     |
| ----------------------------------- | ------------------------------------------------------------------------------- |
| `nexusproxy.healthindicator.bypass` | Allows a player to bypass HealthIndicator behavior, depending on configuration. |

***

### Recommended LuckPerms Setup

#### Staff or Admin bypass

```
/lp group staff permission set nexusproxy.healthindicator.bypass true
```

or:

```
/lp group admin permission set nexusproxy.healthindicator.bypass true
```

{% hint style="info" %}
Only give the bypass permission to groups that should not be affected by HealthIndicator rules.
{% endhint %}

***

### PacketEvents Setup

To use HealthIndicator, install PacketEvents on the Velocity proxy.

The plugin should be placed in your Velocity plugins folder:

```
velocity/
└── plugins/
    ├── NexusProxy-x.x.x.jar
    └── packetevents-velocity-x.x.x.jar
```

After installing PacketEvents, restart the proxy.

{% hint style="warning" %}
Do not enable HealthIndicator before PacketEvents is installed and working.
{% endhint %}

***

### Health Metadata

HealthIndicator can control how player health metadata is handled.

Depending on your configuration, this may include hiding, spoofing, or modifying health values visible to other players or client-side systems.

Example use cases:

* Hide exact health in PvP
* Prevent health indicators from revealing combat information
* Standardize visible health behavior across the network

***

### Absorption Metadata

The module can also handle absorption metadata.

This is useful when you want to control whether absorption hearts or absorption-related information should be visible or modified.

Example use cases:

* Hide absorption status
* Prevent players from reading absorption information
* Control PvP-related metadata visibility

***

### XP Metadata

HealthIndicator can also affect XP metadata depending on configuration.

Example use cases:

* Hide XP-related metadata
* Modify visible XP behavior
* Prevent client-side metadata from exposing unwanted information

***

### Bypass Behavior

Players with the bypass permission may be excluded from HealthIndicator behavior, depending on your configuration.

Bypass permission:

```
nexusproxy.healthindicator.bypass
```

This is useful for:

* Staff testing
* Administrators
* Debugging
* Trusted groups

{% hint style="warning" %}
Do not give bypass permissions to normal players unless they are supposed to ignore HealthIndicator behavior.
{% endhint %}

***

### Common Use Cases

#### Give staff bypass

```
/lp group staff permission set nexusproxy.healthindicator.bypass true
```

***

#### Give admin bypass

```
/lp group admin permission set nexusproxy.healthindicator.bypass true
```

***

### Setup Tips

* Install PacketEvents before enabling the module.
* Restart the proxy after installing PacketEvents.
* Enable the HealthIndicator module only after confirming PacketEvents loads correctly.
* Review bypass permissions carefully.
* Test the behavior with normal players and staff accounts.
* Check `healthindicator.yml` for health, absorption, and XP metadata options.
* Keep the configuration simple at first, then adjust behavior after testing.

***

### Common Issues

#### HealthIndicator does not work

Check that:

* PacketEvents is installed on the Velocity proxy.
* PacketEvents loaded correctly on startup.
* The HealthIndicator module is enabled.
* NexusProxy was restarted after installing PacketEvents.
* The configuration is valid.

***

#### Players still see health information

Check that:

* The correct HealthIndicator options are enabled.
* The affected player does not have `nexusproxy.healthindicator.bypass`.
* PacketEvents is working correctly.
* Another plugin is not modifying the same metadata.

***

#### Staff are affected by HealthIndicator

Check that:

* Staff have `nexusproxy.healthindicator.bypass`.
* The permission is assigned correctly in LuckPerms.
* The bypass behavior is enabled in `healthindicator.yml`, if configurable.

***

#### Console shows PacketEvents-related errors

Check that:

* PacketEvents is installed on the proxy.
* The PacketEvents version is compatible with your Velocity setup.
* The proxy was fully restarted after installation.
* There are no duplicate PacketEvents jars.
* NexusProxy and PacketEvents are both loading correctly.

***

### Summary

The HealthIndicator module provides packet-based control over health, absorption, and XP metadata.

It is recommended for networks that need to hide, spoof, or control player health-related information, especially PvP or competitive networks.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://nexusproxy.nemesismc.net/modules/healthindicator.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
