Version 1.3.9

Author: EssentialGGBot

build-logic/src/main/kotlin/essential/preprocessor.kt

@@ -66,7 +66,7 @@ fun Project.configurePreprocessTree(versions: File) {
         fabric12106.link(fabric12105, versions.resolve("1.21.6-1.21.5.txt"))
         neoForge12105.link(fabric12105)
         forge12105.link(fabric12105)
-        fabric12105.link(fabric12104)
+        fabric12105.link(fabric12104, versions.resolve("1.21.5-1.21.4.txt"))
         neoForge12104.link(fabric12104)
         forge12104.link(fabric12104)
         fabric12104.link(fabric12103, versions.resolve("1.21.4-1.21.3.txt"))

changelog/release-1.3.9.md

@@ -0,0 +1,28 @@
+Title: Fancy Menu Compatibility
+Summary: Fancy Menu compatibility and Essential menu layout redesign
+
+## New Versions
+- Added support for 1.21.8 Fabric
+
+## UI
+- Improved the layout of our buttons on the title screen
+- Improved the design of various modals
+- Added new account switcher modal
+- Added loading screen for switching accounts
+- Removed the condensed variant of the full title screen layout
+- Removed the "Essential Menu", its content was merged into Essential's settings menu
+
+## Bug Fixes
+- Fixed particles of some cosmetics not rendering properly
+- Fixed our buttons on the title and pause screens not supporting animated textures with "Use Minecraft button texture" setting
+- Fixed our buttons on the title and pause screens not supporting nine-slice textures with "Use Minecraft button texture" setting
+- Fixed bad performance in Social Menu related to long messages
+- Fixed cape being slightly darker than it should be in Minecraft 1.16 - 1.21.1
+- Fixed images not resizing correctly after a window resize in the Social Menu
+- Fixed in-solid-block overlay sometimes rendering incorrectly in Minecraft 1.8.9
+- Fixed some GUI components not rendering properly on MacOS in Minecraft 1.21.5 and above
+
+## Compatibility
+- Improved compatibility with the "Fancy Menu" mod, allowing Essential's title and pause screens to be modified
+- Fixed screenshot preview not working with "VanillaFix" mod
+- Fixed drag and drop feature rendering incorrectly with "Fabric API" 0.127.0 and above

features.properties

@@ -3,3 +3,5 @@ nameplate_improvements=true
 server_discovery=true
 updated_gifting_modal=true
 updated_coins_purchase_modal=true
+modal_update=true
+main_menu_improvements=true

gradle.properties

@@ -10,4 +10,4 @@ minecraftVersion=11202
 # TODO remove once upgrading to Loom 1.10
 # fabric-api 1.21.5 was built with Loom 1.10, seems to work well enough in dev with our current 1.7 though
 loom.ignoreDependencyLoomVersionValidation=true
-version=1.3.8.4
+version=1.3.9

gradle/libs.versions.toml

@@ -1,5 +1,5 @@
 [versions]
-universalcraft = "419"
+universalcraft = "425"
 elementa = "708"
 vigilance = "306"
 mixinextras = "0.4.0"

gui/essential/src/main/kotlin/gg/essential/config/EssentialConfig.kt

@@ -379,7 +379,7 @@ object EssentialConfig : Vigilant2(), GuiEssentialPlatform.Config {
 
             subcategory("Date & Time") {
                 selector(timeFormatState) {
-                    name = "Timestamps Format"
+                    name = "Timestamps format"
                     description = "Choose between using 12 or 24 hour time for dates/timestamps in Essential menus."
                     options = listOf("12 Hour", "24 Hour")
                 }
@@ -509,17 +509,6 @@ object EssentialConfig : Vigilant2(), GuiEssentialPlatform.Config {
                     description = "Choose the layout of the Essential buttons on the main and pause menu."
                     options = listOf("Full", "Minimal", "Off")
                 }
-                switch(showQuickActionBarState) {
-                    name = "Quick actions"
-                    description =
-                        "Shows the quick action bar in the main and pause menu. Quickly toggle notifications, cosmetics, and fullscreen."
-                    visible = essentialMenuLayoutState.map { it == 0 }
-                }
-                switch(closerMenuSidebarState) {
-                    name = "Wide-screen menu placement"
-                    description = "Moves the minimal Essential menu closer to the Minecraft menu."
-                    visible = essentialMenuLayoutState.map { it == 1 }
-                }
                 switch(useVanillaButtonForRetexturing) {
                     name = "Use Minecraft button texture"
                     description = "Uses Minecraft’s button texture on Essential main and pause menu buttons. If you have a resource pack equipped, it will use the resource pack’s button texture."
@@ -605,7 +594,7 @@ object EssentialConfig : Vigilant2(), GuiEssentialPlatform.Config {
                     options = listOf("3 seconds", "5 seconds", "7 seconds")
                 }
                 switch(screenshotSoundsState) {
-                    name = "Screenshot Sounds"
+                    name = "Screenshot sounds"
                     description = "Plays a capture sound when taking a screenshot."
                 }
                 switch(enableVanillaScreenshotMessageState) {

gui/essential/src/main/kotlin/gg/essential/cosmetics/diagnostics.kt

@@ -17,6 +17,7 @@ import gg.essential.gui.elementa.state.v2.State
 import gg.essential.gui.elementa.state.v2.memo
 import gg.essential.gui.elementa.state.v2.stateOf
 import gg.essential.mod.Model
+import gg.essential.mod.cosmetics.settings.CosmeticProperty
 import gg.essential.model.BedrockModel
 import gg.essential.model.file.AnimationFile
 import gg.essential.model.file.ParticlesFile
@@ -36,6 +37,8 @@ fun diagnose(modelLoader: ModelLoader, cosmetic: Cosmetic): State<List<Diagnosti
         return stateOf(existingDiagnostics)
     }
 
+    val generalDiagnostics = diagnoseCosmeticGenerally(cosmetic)
+
     val variants = cosmetic.variants?.map { it.name } ?: listOf("")
     val variantsAndSkins = variants.flatMap { variant ->
         val assets = cosmetic.assets(variant)
@@ -107,12 +110,35 @@ fun diagnose(modelLoader: ModelLoader, cosmetic: Cosmetic): State<List<Diagnosti
             }
         }
 
-        existingDiagnostics + diagnostics
+        existingDiagnostics + generalDiagnostics + diagnostics
     }
 }
 
 data class VariantAndSkin(val variant: String, val skin: Model)
 
+private fun diagnoseCosmeticGenerally(cosmetic: Cosmetic): List<Diagnostic> {
+    val diagnostics = mutableListOf<Diagnostic>()
+
+    for (property in cosmetic.properties) {
+        if (property is CosmeticProperty.UsesId) {
+            @Suppress("DEPRECATION")
+            val propertyId = property.id
+            when (property) {
+                is CosmeticProperty.IdShouldBeSelf -> if (propertyId != cosmetic.id) {
+                    val msg = "Expected `id` of `${property.type}` to be `${cosmetic.id}` but was `${propertyId}`."
+                    diagnostics.add(Diagnostic.error(msg, file = "settings.json"))
+                }
+                is CosmeticProperty.IdIsTarget -> {
+                    // TODO could check if target exists, but we don't currently have an good way to get all cosmetics here
+                }
+                else -> throw AssertionError("Type ${property.javaClass} should implement one of the above interfaces.")
+            }
+        }
+    }
+
+    return diagnostics
+}
+
 private fun diagnoseModel(model: BedrockModel): List<Diagnostic> {
     val diagnostics = model.diagnostics.toMutableList()
 

gui/essential/src/main/kotlin/gg/essential/gui/EssentialPalette.kt

@@ -1064,6 +1064,15 @@ object EssentialPalette {
     @JvmField
     val COIN_BUNDLE_0_999: ImageFactory = ResourceImageFactory("/assets/essential/textures/coin/coin_bundle_0_999.png")
 
+    @JvmField
+    val HOST_5X: ImageFactory = ResourceImageFactory("/assets/essential/textures/host_5x.png")
+
+    @JvmField
+    val SMILEY_8X: ImageFactory = ResourceImageFactory("/assets/essential/textures/account/smiley_8x8.png")
+
+    @JvmField
+    val SIGN_OUT_8X7: ImageFactory = ResourceImageFactory("/assets/essential/textures/account/sign_out_8x7.png")
+
     @LoadsResources("/assets/essential/textures/friends/group_[a-z]+.png")
     private fun createGroupIconFactory(name: String): ImageFactory =
         ResourceImageFactory("/assets/essential/textures/friends/group_$name.png")

gui/essential/src/main/kotlin/gg/essential/gui/common/MenuButton.kt

@@ -32,6 +32,8 @@ import gg.essential.gui.common.shadow.EssentialUIText
 import gg.essential.gui.common.shadow.ShadowIcon
 import gg.essential.gui.elementa.state.v2.combinators.map
 import gg.essential.gui.elementa.state.v2.combinators.zip
+import gg.essential.gui.elementa.state.v2.mutableStateOf
+import gg.essential.gui.elementa.state.v2.stateOf
 import gg.essential.gui.image.ImageFactory
 import gg.essential.gui.layoutdsl.LayoutScope
 import gg.essential.gui.layoutdsl.Modifier
@@ -86,7 +88,7 @@ class MenuButton @JvmOverloads constructor(
 
     val hoveredStyleOverrides = BasicState(false) // For manually activating hovered style
     private val tooltipHover = hoveredState()
-    private val styleHover = hoveredState() or hoveredStyleOverrides
+    val styleHover = hoveredState() or hoveredStyleOverrides
     private val collapsed = BasicState(false).map { it }
     private val enabledState = BasicState(true).map { it }
     private var collapsedWidth = 0f
@@ -109,7 +111,7 @@ class MenuButton @JvmOverloads constructor(
     }
     val isTruncated = textState.zip(labelState).map { (text, label) -> text != label }
 
-    private val styleState =
+    val styleState =
         styleHover.zip(enabledState).zip(this.defaultStyle.zip(this.hoverStyle.zip(this.disabledStyle))).map { (hoveredEnabled, styles) ->
             val (hovered, enabled) = hoveredEnabled
             val (standardStyle, hoveredDisableStyles) = styles
@@ -137,6 +139,8 @@ class MenuButton @JvmOverloads constructor(
     // For accessing enabled state value
     val enabled by ReadOnlyState(enabledState)
 
+    var drawsBackground = mutableStateOf(stateOf(true))
+
     @JvmOverloads
     constructor(
         buttonText: String = "",
@@ -398,7 +402,7 @@ class MenuButton @JvmOverloads constructor(
         beforeDraw(matrixStack)
 
         val style = styleState.get()
-        if (style.buttonColor.alpha != 0) {
+        if (drawsBackground.getUntracked().getUntracked() && style.buttonColor.alpha != 0) {
             if (shouldBeRetextured ?: (Window.of(this) == platform.pauseMenuDisplayWindow)) {
                 val hovered = styleHover.get()
                 val (type, texture) = ButtonTextures.currentTexture(hovered)
@@ -410,6 +414,7 @@ class MenuButton @JvmOverloads constructor(
                     // enabled, which is handled in `drawTexturedButton`.
                     // - DARK_GRAY is our default button state.
                     // - GRAY is our default hover state.
+                    // This check is mirrored in [MenuButtonProxy.requiresTinting()], be sure to replicate changes there
                     val isDefaultOrHoveredBaseColor = style.buttonColor == (if (hovered) GRAY else DARK_GRAY).buttonColor
 
                     drawTexturedButton(

gui/essential/src/main/kotlin/gg/essential/gui/common/NoticeFlag.kt

@@ -19,6 +19,8 @@ import gg.essential.elementa.constraints.ChildBasedSizeConstraint
 import gg.essential.elementa.constraints.SiblingConstraint
 import gg.essential.elementa.dsl.*
 import gg.essential.elementa.effects.OutlineEffect
+import gg.essential.elementa.events.UIClickEvent
+import gg.essential.elementa.state.toConstraint
 import gg.essential.gui.EssentialPalette
 import gg.essential.gui.common.shadow.EssentialUIText
 import gg.essential.gui.image.ImageFactory
@@ -27,14 +29,18 @@ import gg.essential.gui.elementa.state.v2.State
 import gg.essential.gui.elementa.state.v2.color.toConstraint
 import gg.essential.gui.elementa.state.v2.combinators.and
 import gg.essential.gui.elementa.state.v2.combinators.map
+import gg.essential.gui.elementa.state.v2.memo
+import gg.essential.gui.elementa.state.v2.mutableStateOf
 import gg.essential.gui.elementa.state.v2.stateOf
 import gg.essential.gui.elementa.state.v2.toV1
+import java.awt.Color
 
 abstract class NoticeFlag(
     style: State<MenuButton.Style>,
 ) : UIBlock() {
 
-    private val backgroundColor = style.map { it.buttonColor }
+    val backgroundHidden = mutableStateOf(stateOf(false))
+    private val backgroundColor = memo { if (backgroundHidden()()) Color(0, 0, 0, 0) else style().buttonColor }
     private val highlightColor = backgroundColor.map { it.brighter() }
     private val shadowColor = backgroundColor.map { it.darker() }
     private val hasLeft = style.map { OutlineEffect.Side.Left in it.sides }
@@ -89,6 +95,12 @@ abstract class NoticeFlag(
             color = backgroundColor.toConstraint()
         }
     }
+
+    fun runAction(){
+        fireClickEvent(UIClickEvent(
+            getLeft(), getTop(), 0, this, this, 1
+        ))
+    }
 }
 
 class TextFlag(
@@ -127,14 +139,16 @@ class TextFlag(
 
 class IconFlag(
     style: State<MenuButton.Style>,
-    image: State<ImageFactory>,
+    // image is not a state as none of our current uses require dynamic icons
+    // if this changes in future see [NoticeFlagProxy.drawBehaviourFromComponentState] as it will require adjustment
+    image: ImageFactory,
 ) : NoticeFlag(style) {
 
     init {
         setWidth((100.percent boundTo contentContainer) + 7.pixels)
 
         contentContainer.layout(Modifier.alignHorizontal(Alignment.Center)) {
-            icon(image.toV1(this@IconFlag), Modifier.color(EssentialPalette.TEXT_HIGHLIGHT).shadow(EssentialPalette.BLACK))
+            icon(image, Modifier.color(EssentialPalette.TEXT_HIGHLIGHT).shadow(EssentialPalette.BLACK))
         }
     }
 }