# obs-overlay

**Repository Path**: superxuqc/obs-overlay

## Basic Information

- **Project Name**: obs-overlay
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: 1.20.5
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-20
- **Last Updated**: 2025-02-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img src="fabric/src/main/resources/assets/obs_overlay/icon.png" alt="Logo" height="128" />

# OBS Overlay
#### Hide HUD elements from OBS stream by making them an overlay.
**[Modrinth &nearr;](https://modrinth.com/mod/obs-overlay)** • **[CurseForge &nearr;](https://www.curseforge.com/minecraft/mc-mods/obs-overlay)** • **[Got an issue?](../../issues/new)**
<br><br>
<br/>

![Preview](.github/preview.png)

## Installation

This mod is **client-only**.\
At the moment only **Windows** is supported.

### Dependencies

- Cloth Config API
- Architectury API
- Fabric API (Fabric only)
- Mod Menu (Optional, Fabric only)

## Features

This mod lets you hide any combination of the following components:

- Debug menu (F3)
- Chat (without input bar)
- Chat input bar
- Player list (TAB)
- Subtitles (accessibility)
- Scoreboard
- Title and Subtitle from /title
- Actionbar from /title
- Effect display
- Main HUD (health, hunger, armor, experience, hotbar)

Additionally this mod lets you hide any combination of the following *screens*:

- Survival inventory
- Creative inventory
- Pause menu
- Command block screen
- Any HandledScreen by it's ID (e.g. `minecraft:anvil`, `minecraft:furnace`)
- All ingame screens

By default only Debug menu (F3) is hidden.

> [!WARNING]
> There is a possibility OBS might capture the HUD if started before game. If you hide any confidential information, make sure to double-check that it's not visible in the stream.<br><br>
> For additional safety you can enable test icon, which is displayed all the time and should not be visible on stream. It should let you check if the mod is working correctly.<br><br>
> **I am not responsible for any confidential information accidentally shown on stream.**

## Usage

Mod settings can be accessed by:
- Clicking `Settings` -> `Video Settings` -> `OBS Overlay settings`
- Opening mod settings through ModMenu (Fabric only)
- Opening mod settings through Mods menu (Forge only)

![Settings](.github/settings.png)

## API

If you want to add support for your own HUD components you can use API provided by this mod.\
Check [API documentation](API.md) for more information.

## License

[MIT](LICENSE)