ModuleNotifier module (#258)

Author: IceTank

src/main/kotlin/com/lambda/event/events/ModuleEvent.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2026 Lambda
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.lambda.event.events
+
+import com.lambda.event.Event
+import com.lambda.event.callback.Cancellable
+import com.lambda.event.callback.ICancellable
+import com.lambda.module.Module
+
+/**
+ * Represents events related to toggling, enabling, and disabling of [Module]s.
+ *
+ * @see Toggle
+ * @see Enabled
+ * @see Disabled
+ */
+sealed class ModuleEvent {
+	/**
+	 * Event that fires before a [Module] is toggled.
+	 */
+	data class Toggle(val module: Module, val newValue: Boolean) : Event
+
+	/**
+	 * Event that fires before a [Module] is enabled.
+	 */
+	data class Enabled(val module: Module) : Event
+
+	/**
+	 * Event that fires before a [Module] is disabled.
+	 */
+	data class Disabled(val module: Module) : Event
+}

src/main/kotlin/com/lambda/module/Module.kt

@@ -28,11 +28,13 @@ import com.lambda.config.settings.complex.Bind
 import com.lambda.config.settings.complex.KeybindSetting.Companion.onPress
 import com.lambda.config.settings.complex.KeybindSetting.Companion.onRelease
 import com.lambda.context.SafeContext
+import com.lambda.event.EventFlow.post
 import com.lambda.event.EventFlow.updateListenerSorting
 import com.lambda.event.Muteable
 import com.lambda.event.OwnerPriority
 import com.lambda.event.events.ClientEvent
 import com.lambda.event.events.ConnectionEvent
+import com.lambda.event.events.ModuleEvent
 import com.lambda.event.listener.Listener
 import com.lambda.event.listener.SafeListener
 import com.lambda.event.listener.SafeListener.Companion.listen
@@ -112,6 +114,8 @@ import com.lambda.util.Nameable
  * }
  * ```
  *
+ * When modules are toggled, enabled or disabled, the corresponding [ModuleEvent] is posted to the event bus before the module state is changed.
+ *
  * See [SafeListener] and [UnsafeListener] for more details.
  */
 abstract class Module(
@@ -160,15 +164,18 @@ abstract class Module(
     }
 
     fun enable() {
+        ModuleEvent.Enabled(this@Module).post()
         isEnabled = true
     }
 
     fun disable() {
+        ModuleEvent.Disabled(this@Module).post()
         isEnabled = false
     }
 
     fun toggle() {
-        isEnabled = !isEnabled
+        ModuleEvent.Toggle(this@Module, !isEnabled).post()
+        if (isEnabled) disable() else enable()
     }
 
     fun onEnable(block: SafeContext.() -> Unit) {

src/main/kotlin/com/lambda/module/modules/client/ModuleNotifier.kt

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2026 Lambda
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.lambda.module.modules.client
+
+import com.lambda.event.events.ModuleEvent
+import com.lambda.event.listener.SafeListener.Companion.listen
+import com.lambda.module.Module
+import com.lambda.module.tag.ModuleTag
+import com.lambda.threading.runSafe
+import com.lambda.util.Communication.log
+import com.lambda.util.Describable
+import com.lambda.util.NamedEnum
+import com.lambda.util.text.TextBuilder
+import com.lambda.util.text.buildText
+import com.lambda.util.text.color
+import com.lambda.util.text.literal
+import net.minecraft.text.Text
+import net.minecraft.util.Colors
+import java.awt.Color
+
+object ModuleNotifier : Module(
+	name = "ModuleNotifier",
+	description = "Notifies you when a module is enabled or disabled",
+	tag = ModuleTag.CLIENT
+) {
+	var notifyTarget by setting("Notify Target", setOf<NotifyTarget>(NotifyTarget.ActionBar), NotifyTarget.entries.toSet(), description = "Where to send notifications when modules are toggled")
+
+	enum class NotifyTarget(override val displayName: String, override val description: String) : Describable, NamedEnum {
+		Chat("Chat", "Sends a message to chat when a module is toggled"),
+		ActionBar("Action Bar", "Sends a message to the action bar when a module is toggled"), ;
+	}
+
+	init {
+		listen<ModuleEvent.Enabled> { event ->
+			logToTargets(event.module) {
+				color(Color(Colors.GREEN)) {
+					literal("on")
+				}
+			}
+		}
+
+		listen<ModuleEvent.Disabled> { event ->
+			logToTargets(event.module) {
+				color(Color(Colors.RED)) {
+					literal("off")
+				}
+			}
+		}
+	}
+
+	private fun logToTargets(module: Module, action: TextBuilder.() -> Unit) {
+		if (NotifyTarget.Chat in notifyTarget) {
+			module.log(TextBuilder().apply(action).build())
+		}
+		if (NotifyTarget.ActionBar in notifyTarget) {
+			module.log(TextBuilder().apply(action).build(), inGameOverlay = true)
+		}
+	}
+}

src/main/kotlin/com/lambda/util/Communication.kt

@@ -101,13 +101,14 @@ object Communication {
         logLevel: LogLevel = LogLevel.Info,
         source: String = "",
         textSource: Text = Text.empty(),
+        inGameOverlay: Boolean = false
     ) {
         buildText {
             text(this@log.source(logLevel, source, textSource))
             text(message)
         }.let { log ->
             runSafeGameScheduled {
-                player.sendMessage(log, false)
+                player.sendMessage(log, inGameOverlay)
             }
         }
     }