Better F3 Hud

# Better F3 HUD

Better F3 HUD is a lightweight, customizable client-side HUD for Minecraft Fabric that brings useful information from the F3 debug screen directly onto your gameplay screen.

Instead of keeping the full F3 screen open, you can choose which information you want to see and keep it visible while playing.

## Features

- **FPS Display** - Keep track of your current FPS and performance.
- **Coordinates** - Display your X, Y, and Z coordinates while playing.
- **Biome Information** - See the biome you are currently in.
- **Entity Information** - View information about the entity you are looking at.
- **Client Information** - Display additional client-side information.
- **Custom HUD Position** - Adjust where the HUD appears on your screen.
- **Custom Colors** - Personalize the appearance of the HUD.
- **Streamer Mode** - Replace selected public information with customizable replacement text while streaming or recording.
- **Configurable Keybinds** - Quickly toggle the HUD and other features using keyboard shortcuts.
- **Custom Settings Screen** - Configure the HUD through an in-game settings interface.
- **Mod Menu Integration** - Access the configuration screen directly through Mod Menu.

## Why use Better F3 HUD?

The vanilla F3 screen provides a lot of useful information, but it also covers a large part of the screen.

Better F3 HUD lets you keep only the information you actually want visible, giving you a cleaner gameplay experience while still having important technical information available at a glance.

## Controls

The default keybinds are:

- **F8** - Toggle the HUD
- **Right Shift** - Open Better F3 HUD settings
- **F7** - Toggle Streamer Mode

These keybinds can be changed through Minecraft's Controls settings.

## Streamer Mode

Streamer Mode is designed for players who want to avoid displaying selected information publicly while streaming or recording.

When enabled, configured information can be replaced with custom text such as:

`Coordinates: Hidden`

`Biome: Hidden`

Minecraft normally renders the same game image for the player and capture software, so Streamer Mode changes the information rendered by the HUD rather than creating a separate private HUD for the player and OBS.

## Configuration

Better F3 HUD includes an in-game configuration screen where you can customize the HUD without manually editing configuration files.

You can configure available modules, appearance options, colors, positioning, and Streamer Mode settings.

## Compatibility

Better F3 HUD is a **client-side Fabric mod**.

It does not need to be installed on the server.

### Required

- Minecraft Fabric
- Fabric Loader
- Fabric API

### Optional

- Mod Menu for in-game configuration access

## Important

Better F3 HUD is intended to provide information and customization for the player's HUD. It does not add combat automation, movement modifications, X-ray functionality, or other gameplay advantages.

## Feedback and Bug Reports

If you encounter a problem, please include:

- Minecraft version
- Fabric Loader version
- Fabric API version
- Better F3 HUD version
- Other installed mods
- Crash report or relevant log
- Steps to reproduce the problem

Suggestions and feature requests are also welcome.

## License

See the included `LICENSE` file for the project's licensing terms.