stunnable

# 🟢 Stunnable Mod

A minimal, high-performance client-side Fabric mod that adds highly customizable, reactive visual rendering boxes and outlines around target players within reach range.

Perfect for maintaining spatial awareness and monitoring stun / interaction ranges with fluid animations, rainbow effects, and breathing transitions. 🌟

# 📋 Table of Contents

• [⚡ Quick Start](#-quick-start)
• [🧠 How It Works — Core Architecture](#-how-it-works--core-architecture)
• [⚙️ Configuration Options](#️-configuration-options)
• [✨ Visual Effects System](#-visual-effects-system)
• [🔌 Integration & ModMenu](#-integration--modmenu)

# ⚡ Quick Start

1. Ensure you have: - Fabric Loader - Fabric API - Cloth Config - AutoConfig

2. Drop the `stunnable.jar` file into your:

```text .minecraft/mods ```

3. Launch the game.

4. Open the configuration screen directly through ModMenu. 🛠️

Customize: - Colors 🎨 - Rainbow rendering 🌈 - Breathing opacity transitions 🫁 - Outline width 📏 - Fill opacity 🔥

Perfectly tune the HUD style to your preference.

# 🧠 How It Works — Core Architecture

The mod operates entirely client-side, hooking directly into Minecraft's rendering lifecycle to draw smooth overlays around nearby targets. 🖥️

## 🔄 Core Initialization

The mod uses standard Fabric entry points for initialization and configuration setup.

### `StunnableClient`

Implements:

```java ClientModInitializer ```

Responsible for: - Client-side initialization - Secondary configuration handling

### `Stunnable`

Implements:

```java ClientModInitializer ```

Responsible for: - Registering AutoConfig schemas - Hooking into Fabric render lifecycle events

# 🎨 Rendering Lifecycle Hook

Inside `Stunnable.java`, the mod subscribes to:

```java WorldRenderEvents. END_MAIN.register(context -> { ... }); ```

This ensures: - Rendering updates every frame - No game tick delay - No block update dependency - Extremely smooth visual tracking

# 📐 Positioning & Calculation Pipeline

## 🎯 Reach Restrictions

The mod dynamically extracts player interaction range using entity attributes:

```java double reach = mc.player.getAttributeValue(Attributes. ENTITY_INTERACTION_RANGE); ```

## 📦 Relative Delta Rendering

Bounding boxes are translated into camera-relative local coordinates to eliminate render jitter:

```java AABB box = player.getBoundingBox().move(-camPos.x, -camPos.y, -camPos.z); ```

## 🚫 Target Exclusions

The renderer loops through loaded players while excluding the local player:

```java if (player != mc.player && playerPos.distanceTo(player.position()) <= reach) ```

# ⚙️ Configuration Options

The mod includes a complete configurable rendering system accessible through: - ModMenu - Cloth Config UI - AutoConfig config files

# 🖼️ Render Category

Controls: - Box visuals - Outline width - Opacity - Base colors

| Option | Type | Default | Purpose | |---|---|---|---| | `fillColor` | Color Picker (Hex) | `0x00FF00` | Inside box face color | | `outlineColor` | Color Picker (Hex) | `0x00FF00` | Bounding edge color | | `onlyOutline` | Boolean | `false` | Disables fill rendering | | `fillOpacity` | Bounded Discrete (0-100) | `50` | Fill transparency | | `outlineWidth` | Bounded Discrete (1-5) | `2` | Line thickness |

# 🌈 Effects Category

Handles: - Dynamic colors - Animated transparency - Procedural visual effects

| Option | Type | Default | Purpose | |---|---|---|---| | `rainbowMode` | Boolean | `false` | Enables HSV rainbow cycling | | `rainbowSpeed` | Bounded Discrete (1-20) | `5` | Hue transition speed | | `rainbowFillOnly` | Boolean | `true` | Rainbow affects fill only | | `breathingEnabled` | Boolean | `false` | Enables opacity breathing | | `breathingSpeed` | Bounded Discrete (1-20) | `5` | Breathing cycle speed | | `breathingStrength` | Bounded Discrete (0-100) | `50` | Breathing intensity |

# ✨ Visual Effects System

# 🌈 Color Mathematics (HSV → RGB)

When rainbow mode is enabled, colors are generated dynamically using time-synchronized HSV calculations.

This creates: - Smooth gradients - No stuttering - Continuous spectrum transitions

```java private int hsvToRgb(float hue, float saturation, float value) { int h = (int) (hue 6); float f = hue 6 - h; float p = value (1 - saturation); float q = value (1 - f saturation); float t = value (1 - (1 - f) * saturation);

float r, g, b;

switch (h % 6) { case 0 -> { r = value; g = t; b = p; } case 1 -> { r = q; g = value; b = p; } case 2 -> { r = p; g = value; b = t; } case 3 -> { r = p; g = q; b = value; } case 4 -> { r = t; g = p; b = value; } case 5 -> { r = value