Skip to content

Commit

Permalink
cool readme
Browse files Browse the repository at this point in the history
  • Loading branch information
not-coded committed Aug 27, 2024
1 parent 140f727 commit 951bbf1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# WayFix

[![Supports minecraft versions from 1.16](https://notcoded.needs.rest/r/badge_minecraft_1.16plus.svg)](https://minecraft.net) ![Won't support forge](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/unsupported/forge_vector.svg)
[![Supports minecraft versions from 1.16](https://notcoded.needs.rest/r/badge_minecraft_1.16plus.svg)](https://minecraft.net) [![Cloth Config API](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/requires/cloth-config-api_vector.svg)](https://www.modrinth.com/mod/cloth-config) ![Won't support forge](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/unsupported/forge_vector.svg)

Fixes multiple issues regarding Wayland compatibility for Minecraft.

### Recommended to be used with [glfw-wayland](https://github.com/BoyOrigin/glfw-wayland).

## Features
- todo
- **Auto Scale GUI**
- Auto-scales the GUI scale depending on your display's scaling. ***[may look weird when windowed]*** (e.g. 2 GUI Scale on 1920x1080 at 100% -> 4 GUI Scale on 3840x2160 at 200%)

- Inject Minecraft Icon at Startup
- Injects the Minecraft Icon at Startup instead of defaulting to the normal Wayland icon.

- **Fullscreen**
- Use Primary Monitor
- Full-screens the window in your primary monitor. ***(Minecraft sometimes full-screens on the wrong monitor due to Wayland limitations)***

- Specify Monitor ***(todo)***
- Specify which monitor you want to fullscreen Minecraft to.

## Building
- Clone the repository
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/assets/wayfix/lang/en_us.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"text.autoconfig.wayfix.title": "WayFix Options",

"text.autoconfig.wayfix.option.autoScaleGUI": "Auto Scale GUI",
"text.autoconfig.wayfix.option.autoScaleGUI.@Tooltip": "Auto scales the GUI scale depending on your display's scaling. [may look weird when windowed] (e.g. 2 GUI Scale on 1920x1080 at 100% -> 4 GUI Scale on 3840x2160 at 200%)",
"text.autoconfig.wayfix.option.autoScaleGUI.@Tooltip": "Auto-scales the GUI scale depending on your display's scaling. [may look weird when windowed] (e.g. 2 GUI Scale on 1920x1080 at 100% -> 4 GUI Scale on 3840x2160 at 200%)",

"text.autoconfig.wayfix.option.injectIcon": "Inject Minecraft Icon at Startup",
"text.autoconfig.wayfix.option.injectIcon.@Tooltip": "Injects the Minecraft Icon at Startup instead of defaulting to the normal Wayland icon (requires restart).",
Expand Down

0 comments on commit 951bbf1

Please sign in to comment.