85 lines
5.2 KiB
TOML
85 lines
5.2 KiB
TOML
# This is an example mods.toml file. It contains the data relating to the loading mods.
|
|
# There are several mandatory fields (#mandatory), and many more that are optional (#optional).
|
|
# The overall format is standard TOML format, v0.5.0.
|
|
# Note that there are a couple of TOML lists in this file.
|
|
# Find more information on toml format here: https://github.com/toml-lang/toml
|
|
# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml
|
|
modLoader="javafml" #mandatory
|
|
# A version range to match for said mod loader - for regular FML @Mod it will be the forge version
|
|
loaderVersion="[28,)" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
|
|
# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties.
|
|
# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here.
|
|
license="GPL-3.0-only"
|
|
# A URL to refer people to when problems occur with this mod
|
|
issueTrackerURL="https://github.com/Markil3/MinecraftImmersiveHUD/issues" #optional
|
|
# A list of mods - how many allowed here is determined by the individual mod loader
|
|
[[mods]] #mandatory
|
|
# The modid of the mod
|
|
modId="immersive_hud" #mandatory
|
|
# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
|
|
# ${file.jarVersion} will substitute the value of the Implementation-Version as read from the mod's JAR file metadata
|
|
# see the associated build.gradle script for how to populate this completely automatically during a build
|
|
version="${file.jarVersion}" #mandatory
|
|
# A display name for the mod
|
|
displayName="Immersive HUD" #mandatory
|
|
# A URL to query for updates for this mod. See the JSON update specification https://mcforge.readthedocs.io/en/latest/gettingstarted/autoupdate/
|
|
updateJSONURL="https://raw.githubusercontent.com/Markil3/MinecraftImmersiveHUD/master/update-forge.json" #optional
|
|
# A URL for the "homepage" for this mod, displayed in the mod UI
|
|
displayURL="https://www.planetminecraft.com/mod/immersive-hud/" #optional
|
|
# A file name (in the root of the mod JAR) containing a logo for display
|
|
logoFile="immersive_hud_logo.png" #optional
|
|
# A text field displayed in the mod UI
|
|
credits="Minecraft Rendering Code (c) 2009-2021 Mojang Studios" #optional
|
|
# A text field displayed in the mod UI
|
|
authors="Markil 3"
|
|
# The description text for the mod (multi line!) (#mandatory)
|
|
description='''
|
|
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.
|
|
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.
|
|
* Potion icons will only show up when first applied or about to run out.
|
|
'''
|
|
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
|
|
[[dependencies.immersive_hud]]
|
|
# the modid of the dependency
|
|
modId="forge" #mandatory
|
|
# Does this dependency have to exist - if not, ordering below must be specified
|
|
mandatory=true #mandatory
|
|
# The version range of the dependency
|
|
versionRange="[28,)" #mandatory
|
|
# An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
|
|
ordering="NONE"
|
|
# Side this dependency is applied on - BOTH, CLIENT or SERVER
|
|
side="CLIENT"
|
|
|
|
[[dependencies.immersive_hud]]
|
|
# the modid of the dependency
|
|
modId="cloth-config" #mandatory
|
|
# Does this dependency have to exist - if not, ordering below must be specified
|
|
mandatory=false #mandatory
|
|
# The version range of the dependency
|
|
versionRange="[4.11,)" #mandatory
|
|
# An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
|
|
ordering="BEFORE"
|
|
# Side this dependency is applied on - BOTH, CLIENT or SERVER
|
|
side="CLIENT"
|
|
# Here's another dependency
|
|
[[dependencies.immersive_hud]]
|
|
modId="minecraft"
|
|
mandatory=true
|
|
# This version range declares a minimum of the current minecraft version up to but not including the next major version
|
|
versionRange="[1.15,1.16)"
|
|
ordering="NONE"
|
|
side="CLIENT"
|