Initial Commit (1.0)

2026-04-28 11:34:17 +02:00 · 2024-09-07 18:54:20 +02:00
commit 6ef0f3758d
42 changed files with 2893 additions and 0 deletions
@@ -0,0 +1,42 @@
+# Widgets
+**Adds customizable in-game widgets to your game.**
+
+![Screenshot of in-game hud](https://github.com/user-attachments/assets/362ffd66-75c2-487c-9d2a-21096ff2d042)
+
+This Minecraft mod adds customizable widgets that you may know from other Minecraft clients.
+
+This mod was specifically made for people who just use Fabric or Quilt (and no specific client).
+It also has some benefits over using clients:
+1. Performance:
+   - We've tried to optimize the mod as much as possible to make sure the game runs as smoothly as possible.
+   - Disabled widgets don't use any performance
+2. No additional features
+   - The mod focuses on **widgets only**. It does not contain any other features such as performance improvements or mods.
+3. Easy to use
+   - We've tried to make the mod as easy to use as possible, for example, there are three ways to open the config menu instead of only a keybind.
+
+## Widget settings
+There are three ways to open the widget settings:
+1. Press the key bind (bound to right shift by default)
+2. Enter the command "/widgetsmod"
+3. Open the config menu through [Mod Menu](https://modrinth.com/mod/modmenu)
+
+Once you've opened the settings, you will see something like this:
+
+![Widget Settings menu](https://github.com/user-attachments/assets/a8f8ac2d-6077-4de9-bf77-2968f8b7dbcf)
+
+You can now enable the widgets you want to enable, or click on them to view their additional settings, as you can see here:
+
+![CPS Widget Settings](https://github.com/user-attachments/assets/3703abb2-5f51-42dc-90e4-5847a9e0cc73)
+
+When you're done with configuring which widgets you want to enable and their settings, click the "Edit Layout" button in the bottom right corner.
+
+![Edit Layout button](https://github.com/user-attachments/assets/a788b082-ecb6-4a54-ba9c-cf513f128f2e)
+
+This will take you to a screen where you can freely move around your enabled widgets.
+
+![Edit Layout screen](https://github.com/user-attachments/assets/02f20215-8be1-4997-9a90-8ef7eb3662d9)
+
+When you're done, just press Escape until you return to the game.
+
+Now, everything is done. Your widgets automatically save for the next time you play.