Skip to content

Commit

Permalink
Fix grammar and spelling in README (#88)
Browse files Browse the repository at this point in the history
* Fix gramamar and spelling

* Fix link
  • Loading branch information
CuriousCodingCanadian authored Oct 25, 2024
1 parent 7a4c390 commit 1bc354f
Showing 1 changed file with 18 additions and 20 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The mod linked above has more features and lots of unsolved bugs are already fix

Available to download from [Modrinth](https://modrinth.com/mod/simple-hud-utilities) or [Curseforge](https://www.curseforge.com/minecraft/mc-mods/simple-utilities).

Built using [Fabric Example Mod Template](https://github.com/FabricMC/fabric-example-mod) and made with the [Fabric](https://fabricmc.net) modding toolchain for Minecraft.
Built using the [Fabric Example Mod](https://github.com/FabricMC/fabric-example-mod) and made with the [Fabric](https://fabricmc.net) modding toolchain for Minecraft.

A Minecraft Mod that enhances the Game's HUD with some simple utilities like the following:

Expand All @@ -30,25 +30,24 @@ A Minecraft Mod that enhances the Game's HUD with some simple utilities like the
- Nether/overworld coordinates conversion
- Toggle key (editable in Controls screen, default is `k`)
- Settings page and config file with Mod Menu
- **Requires [Mod Menu mod](https://www.curseforge.com/minecraft/mc-mods/modmenu) to open settings screen in-game**
- Config file: `.minecraft/config/simple_utilities.toml` (does not require Mod Menu mod to edit)
- **Requires [Mod Menu](https://modrinth.com/mod/modmenu) to open settings screen in-game**
- Config file: `.minecraft/config/simple_utilities.toml` (does not require Mod Menu to edit)

---

## Images

| In-game HUD | Settings page (Requires [ModMenu Mod](https://www.curseforge.com/minecraft/mc-mods/modmenu)) |
| In-game HUD | Settings page (Requires [Mod Menu](https://modrinth.com/mod/modmenu)) |
| --------------------------------------| ----------------------------------------- |
| ![In-game HUD](images/ingame_hud.png) | ![Settings HUD](images/settings_hud.png) |

---

## Installation

- Install [Fabric Loader](https://fabricmc.net/use/) on your Minecraft client
- Download the latest Mod `.jar` from [Github](https://github.com/johnvictorfs/simple-utilities-mod/releases/latest) or from [Curseforge](https://www.curseforge.com/minecraft/mc-mods/simple-utilities)
- Put the downloaded Mod `.jar` in the `.minecraft/mods` folder
- Done!
- Install [Fabric](https://fabricmc.net/use/).
- Download the latest version of Simple Utilities (in the `.jar` file format) from [GitHub](https://github.com/johnvictorfs/simple-utilities-mod/releases/latest) or from [Modrinth](https://modrinth.com/mod/simple-hud-utilities).
- Move the downloaded file into the `.minecraft/mods` folder.

---

Expand All @@ -57,12 +56,11 @@ A Minecraft Mod that enhances the Game's HUD with some simple utilities like the
Building from source
</summary>

- Clone the project with `git clone https://github.com/johnvictorfs/simple-utilities-mod.git`
- Cd into the project's directory `cd simple-utilities-mod`
- Run `./gradlew build` to build the `.jar`
- Built Mod `.jar` files will be located at `build/libs`
- Example: `build/libs/simple-utilities-mod-1.0.0.jar`
- This will be the Mod `.jar` file you can put in your `.minecraft/mods` folder
- Clone the project with `git clone https://github.com/johnvictorfs/simple-utilities-mod.git`.
- Change to the project's directory with `cd simple-utilities-mod`.
- Run `./gradlew build` to build the mod.
- The built mod will be located in the `build/libs` folder.
- There will be two files. Use the one without `sources` in the filename.
</details>

---
Expand All @@ -75,18 +73,18 @@ Planned features
- Add configuration to move any specific HUD elements around the screen (drag-and-drop if possible)
- Add option for E counter (entities) and C counter (chunk sections) (possibly M/C counters as well (monsters/creatures))
- Add current status effects duration to HUD
- Add Sun/Moon icons to the current game time, so it's easier to notice if it's Day or Night
- Add Sun/Moon icons to the current game time, so it's easier to tell if the time of day is Day or Night
</details>

---

## FAQ

- **Does this Mod work on versions below 1.15?**
- No, it *might* work on 1.14 with some changes, but not anything below 1.14, since this Mod is made with Fabric, which only supports Minecraft 1.14 and above.
- No. It *might* work on 1.14 with some changes, but cannot work below 1.14, since this mod is made with Fabric, which only supports Minecraft 1.14 and above.

- **Will this Mod get me banned from *X multiplayer server*?**
- Maybe, maybe not, the Mod is entirely Client-sided and does not require it to be installed on the Server, and mostly shows things already available to you at all times like coordinates and Cardinal directions, like an extended but simplified F3 Menu, but it has some exceptions, like very specific Game time, so some servers may not allow it, do look into the Server's rules carefully before using it, do **not** create issues here asking about that, since I won't know.
- **Will this Mod get me banned from *(some multiplayer server)*?**
- It depends on the server you are playing on. This mod runs entirely on the client-side (your computer) and does not support nor require server installation. The mod (mostly) shows things that are accessible through in-game features, such as the F3 Menu. Some features are not directly accessible in the vanilla game, such as very specific game time. Whether these are allowed depends on the server. Do not create issues about this here. Instead, check the rules of the server you intend to use this mod on.

- **Will you add '*X feature not present in the [Planned Features](#planned-features) section*'**?
- Maybe, and only if it fits with the other features of the mod, create [an issue](https://github.com/johnvictorfs/simple-utilities-mod/issues/new) about it, I only work on this project on my spare time, but I'd be happy to add wanted features if I can get around to it.
- **Will you add '*(some feature not present in the [Planned Features](#planned-features) section)*'**?
- Maybe. If it is related to the functionality of this mod, create [an issue](https://github.com/johnvictorfs/simple-utilities-mod/issues/new) about it. I can only add requested features during my spare time, so do not expect a timely response.

0 comments on commit 1bc354f

Please sign in to comment.