Compare commits

...

9 Commits

Author SHA1 Message Date
William Hubbard
47098e1101 Update README.md
Adds information on the transference of the copyright.
2022-03-11 22:30:19 +00:00
Markil3
b7f7c4bc70 Update update-forge.json 2021-04-01 18:43:50 -06:00
Markil3
8e02a0fe75 Fixes syntax error in update-forge 2021-03-03 08:54:24 -07:00
Markil3
bbd6c01aa1 Update update-forge.json 2021-03-03 08:54:00 -07:00
Markil3
bd95fb1297 Changes the provided URL that the user is sent to.
Updates are more efficient this way.
2021-03-02 12:24:29 -07:00
Markil3
0dfdd59764 More syntax errors in update-forge.json 2021-03-02 12:17:13 -07:00
Markil3
8688812e71 Fixes a syntax error in update-forge.json 2021-03-02 12:14:29 -07:00
Markil3
595820873a Creates the Forge update file 2021-03-02 11:34:42 -07:00
Markil3
7b780f1964 Readme patch (#1)
* Create README.md

* Added some screenshots for the README.

* Added screenshots to README

* Adds a gif animation to the README demonstrating the mod.
2021-02-24 11:01:34 -07:00
8 changed files with 119 additions and 0 deletions

42
README.md Normal file
View File

@@ -0,0 +1,42 @@
# MinecraftImmersiveHUD
This Minecraft mod aims to move the ingame HUD out of the way whenever possible. Whenever an element updates
(i.e., health changes, you swap items, you look at something, etc.), the respective item will show
up. However, once you've been able to see the information, it will fade away and allow you to enjoy
your game without the clutter of unneeded HUD elements.
![screenshot1](screenshot1.png)![screenshot2](screenshot2.png)![screenshot3](screenshot3.png)![screenshot4](screenshot4.png)![screenshot5](screenshot5.png)
![demo](demo.gif)
The following elements will only show up under certain conditions:
* The health and armor bars will only show up when your health changes (i.e. after taking damage), when your health is low or when holding food.
* The hunger bar will only show up when your hunger level (not your saturation) changes, you are hungry, or when holding food.
* The experience bar and level will only show upon gaining experience.
* The health of your mount (i.e. your horse) will only show when its health changes.
* The horse jump bar will only show when you are getting ready to jump.
* The hotbar will only show when an item you are holding changes or you change which slot is selected.
* The crosshair will only show when you are looking at something or you are using a bow, crossbow, shield, or trident or holding a throwable item.
* The hands will show only when you use an item or are holding/using one of the above specified items, or a map.
# An update on the future of this mod.
*Hello, everyone.*
*I've recently taken on a new job, and, due to the demands of a full-time developer job, I will no longer be able to maintain this project. I've had a lot of fun with it, but continuing it for the future is simply unfeasible.*
*With that said, I am willing to transfer the project, copyright and all, to someone else who is willing to maintain it. If you happen to be interested, email me at markil3@tutanota.com and we can discuss it.*
*Once a transfer is complete, I will post an update here and on the PlanetMinecraft page.*
*I thank you all for the support you've shown in this.*
*May God bless you all,*
*Markil 3*
# Installing
There are two variants of this mod: One for Forge, and the other for Fabric. Each [release](https://github.com/Markil3/MinecraftImmersiveHUD/releases) comes with jar files for both. You can download the appropriate jar file and place it within the "mods" folder within your Minecraft installation. For more details, see the README files of the appropriate branches.
# Building
Simply run the "gradle build" (or "./gradlew build" on OSX and Linux) to create a distributable jar file. You can find it within the build/libs directory.
# Licensing
This mod is licensed under the GNU General Public License version 3.0. In short, you are allowed to use and modify this mod for whatever you wish (including commercial use), but all distributions (modified or otherwise) must be under the same license, contain the source code (with changes highlighted), and preserve the copyright notices.

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 MiB

BIN
screenshot1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
screenshot2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 767 KiB

BIN
screenshot3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

BIN
screenshot4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 983 KiB

BIN
screenshot5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 405 KiB

77
update-forge.json Normal file
View File

@@ -0,0 +1,77 @@
{
"homepage": "https://github.com/Markil3/MinecraftImmersiveHUD/releases",
"1.14": {
"1.0-1.14-forge": "Removes support for Cloth Config.",
"1.1-1.14-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.14-forge": "Bug fixes."
},
"1.14.1": {
"1.0-1.14-forge": "Removes support for Cloth Config.",
"1.1-1.14-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.14-forge": "Bug fixes."
},
"1.14.2": {
"1.0-1.14-forge": "Removes support for Cloth Config.",
"1.1-1.14-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.14-forge": "Bug fixes."
},
"1.14.3": {
"1.0-1.14-forge": "Removes support for Cloth Config.",
"1.1-1.14-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.14-forge": "Bug fixes."
},
"1.14.4": {
"1.0-1.14-forge": "Removes support for Cloth Config.",
"1.1-1.14-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.14-forge": "Bug fixes."
},
"1.15": {
"1.0-1.15-forge": "Removes support for Cloth Config.",
"1.1-1.15-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.15-forge": "Bug fixes."
},
"1.15.1": {
"1.0-1.15-forge": "Removes support for Cloth Config.",
"1.1-1.15-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.15-forge": "Bug fixes."
},
"1.15.2": {
"1.0-1.15.2-forge": "Removes support for Cloth Config.",
"1.1-1.15.2-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.15.2-forge": "Bug fixes."
},
"1.16.4": {
"0.1-1.16.4-forge": "Initial release",
"1.0-1.16.4-forge": "Causes potion effects to fade, adds sliding animations to the hotbar, experience, and jump bars, and adds support for configuring the timings.",
"1.1-1.16.4-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.16.4-forge": "Bug fixes."
},
"1.16.5": {
"0.1-1.16.4-forge": "Initial release",
"1.0-1.16.4-forge": "Causes potion effects to fade, adds sliding animations to the hotbar, experience, and jump bars, and adds support for configuring the timings.",
"1.1-1.16.4-forge": "Gives players the option of preventing hands and crosshairs from fading.",
"1.1.1-1.16.4-forge": "Bug fixes."
},
"promos": {
"1.14-latest": "1.1.1-1.14-forge",
"1.14-recommended": "1.1.1-1.14-forge",
"1.14.1-latest": "1.1.1-1.14-forge",
"1.14.1-recommended": "1.1.1-1.14-forge",
"1.14.2-latest": "1.1.1-1.14-forge",
"1.14.2-recommended": "1.1.1-1.14-forge",
"1.14.3-latest": "1.1.1-1.14-forge",
"1.14.3-recommended": "1.1.1-1.14-forge",
"1.14.4-latest": "1.1.1-1.14-forge",
"1.14.4-recommended": "1.1.1-1.14-forge",
"1.15-latest": "1.1.1-1.15-forge",
"1.15-recommended": "1.1.1-1.15-forge",
"1.15.1-latest": "1.1.1-1.15-forge",
"1.15.1-recommended": "1.1.10-1.15-forge",
"1.15.2-latest": "1.1.1-1.15.2-forge",
"1.15.2-recommended": "1.1.1-1.15.2-forge",
"1.16.4-latest": "1.1.1-1.16.4-forge",
"1.16.4-recommended": "1.1.1-1.16.4-forge",
"1.16.5-latest": "1.1.1-1.16.4-forge",
"1.16.5-recommended": "1.1.1-1.16.4-forge"
}
}