Skip to content

Update README with user instructions and troubleshooting #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rrtt217 merged 5 commits into from
Feb 16, 2026
Merged

Update README with user instructions and troubleshooting #9

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d21c60
Update README with user instructions and troubleshooting
XgarhontX Feb 16, 2026
026a5c8
Clarify screenshot feature description in README
XgarhontX Feb 16, 2026
ce9a8b3
Fix link to Patrix resource pack in README
XgarhontX Feb 16, 2026
c41a507
Add link to Visual C++ Redistributable in README
XgarhontX Feb 16, 2026
71879fa
grammar
XgarhontX Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Minecraft HDR Mod
A minecraft mod that enables native HDR on Windows/Linux with Iris shaders. Currently in early development.
[![PhotonHDRPic](https://i.postimg.cc/tgRwc3x5/2026-02-15-20-07-37-hdr.png)](https://postimg.cc/LJ7xYZvY)
([Photon](https://modrinth.com/shader/photon-shader) patched to HDR w/ [Patrix](https://modrinth.com/resourcepack/patrix-32x), taken by mod's screenshot feature.)
## What the mod have achieved
- Native HDR, both for Windows scRGB and HDR10/PQ;
- UI color correction by a BEFORE_BLIT pass;
- Ingame config using Cloth Config API;
- Native HDR, both for Windows scRGB and HDR10/PQ.
- UI color correction by a BEFORE_BLIT pass.
- Ingame config using Cloth Config API.
- Ingame HDR screenshot.
## For users
- Adjust the config ingame using a key binding (default F9);
- Take an HDR screenshot ingame using a key binding (default F10);
- If your game is too bright/dark, try adjust the custom brightness values yourself;
- If you're on Windows, don't forget to install the latest Visual C++ Redistributable.
- If your game crashes on NeoForge, disable `earlyWindowControl` in `<game folder>/config/fml.toml`
- Clean temp file if your game doesn't start (path can be found in log, %TEMP%/glfw on Windows and /tmp/glfw on Linux).
## For shader patches
## For Users
- See XgarhontX's temporary patches for HDR output and tonemapping on select shaderpacks with support for this mod: [Google Sheets](https://docs.google.com/spreadsheets/d/1WgOqKED2FxC11-2oyW4aBIyl8tAHo-8WJ7JPxhYAO2Q/edit?gid=0#gid=0)
- Adjust HDR Brightness values (Paper White, UI, Peak) with config menu. (Default keybind: F9)
- Take a HDR screenshot ingame. (Default keybind: F10)
- *Troubleshooting*: ReShade is currently not compatible, failing to load and breaking sky.
- *Troubleshooting*: If your game is too bright/dark, try adjust the custom brightness values yourself.
- *Troubleshooting*: If you're on Windows, don't forget to install the latest [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
- *Troubleshooting*: If your game crashes on NeoForge, disable `earlyWindowControl` in `<game folder>/config/fml.toml`
- *Troubleshooting*: Clean temp file if your game doesn't start (path can be found in log, %TEMP%/glfw on Windows and /tmp/glfw on Linux).
## For Shader Packs
### Macros
- `HDR_MOD_INSTALLED`
- `HDR_ENABLED`
Expand Down