mirror of
https://github.com/Gabi-Zar/Toggle-HUD-Silksong-mod.git
synced 2026-04-17 05:46:05 +02:00
Initial commit: add source files and project
This commit is contained in:
47
README.md
Normal file
47
README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
<h1 align="center">Toggle HUD — Silksong Mod</h1>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue?style=for-the-badge">
|
||||
<img alt="Stars" src="https://img.shields.io/github/stars/Gabi-Zar/Toggle-HUD-Silksong-mod?style=for-the-badge&color=magenta">
|
||||
<img alt="Forks" src="https://img.shields.io/github/forks/Gabi-Zar/Toggle-HUD-Silksong-mod?style=for-the-badge&color=purple">
|
||||
<img alt="License" src="https://img.shields.io/github/license/Gabi-Zar/Toggle-HUD-Silksong-mod?style=for-the-badge&color=blue">
|
||||
<br>
|
||||
<a href="https://github.com/Gabi-Zar"><img title="Developer" src="https://img.shields.io/badge/developer-GabiZar-red?style=flat-square"></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
This repository contains a **BepInEx 5 mod for Silksong** that allows you to toggle the HUD visibility using **F11**.
|
||||
|
||||
## 🌟 Features
|
||||
|
||||
- Toggle the in-game HUD visibility by pressing **F11**.
|
||||
|
||||
## 🔗 Requirements
|
||||
|
||||
- [BepInEx 5](https://www.nexusmods.com/hollowknightsilksong/mods/26)
|
||||
|
||||
## 🚀 Installation & Usage
|
||||
|
||||
1. Download the mod `.dll` from the [GitHub Releases](https://github.com/Gabi-Zar/Toggle-HUD-Silksong-mod/releases) page or from [Nexus Mods](https://www.nexusmods.com/hollowknightsilksong/mods/673).
|
||||
|
||||
2. Place the `.dll` file in the following folder:
|
||||
```
|
||||
Hollow Knight Silksong\BepInEx\plugins
|
||||
```
|
||||
|
||||
3. Launch the game and press **F11** to toggle the HUD on or off.
|
||||
|
||||
## 🧩 Compatibility
|
||||
|
||||
- Compatible with **BepInEx 5**.
|
||||
- Tested with the latest Silksong build (20283943).
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is licensed under the [MIT License](LICENSE).
|
||||
|
||||
---
|
||||
|
||||
<p align="center">If you like this mod, consider giving it a ⭐ on GitHub!</p>
|
||||
|
||||
Reference in New Issue
Block a user