Improved how freecam works, split client and server code, cleaned code, etc

Author: Apollointhehouse

build.gradle

@@ -90,8 +90,8 @@ dependencies {
 	// Helper library
 	// If you do not need Halplibe you can comment this line out or delete this line
 	modImplementation("turniplabs:halplibe:${project.halplibe_version}")
-
 	modImplementation("turniplabs:modmenu-bta:${project.mod_menu_version}")
+	modImplementation("com.github.Apollointhehouse:Raywire:$raywire_version")
 
 	implementation "org.slf4j:slf4j-api:1.8.0-beta4"
 	implementation "org.apache.logging.log4j:log4j-slf4j18-impl:2.16.0"
@@ -121,8 +121,6 @@ dependencies {
 	implementation("org.lwjgl:lwjgl-opengl:$lwjglVersion")
 	implementation("org.lwjgl:lwjgl-stb:$lwjglVersion")
 
-	modImplementation("com.github.Apollointhehouse:Raywire:1.0.0")
-
 	modImplementation("net.fabricmc:fabric-language-kotlin:${project.flk_version}+kotlin.${project.kotlin_version}") {
 		exclude(group: "net.fabricmc", module: "fabric-loader")
 	}

gradle.properties

@@ -10,12 +10,13 @@ loader_version=0.15.6-bta.7
 # Other Mods
 mod_menu_version=3.0.0
 halplibe_version=5.2.4
+raywire_version=1.0.0
 
 # Fabric Language Kotlin
 flk_version=1.11.0
 kotlin_version=2.0.0
 
 # Mod
 mod_version=1.0.0
-mod_group=turniplabs
-mod_name=examplemod
+mod_group=me.apollointhehouse
+mod_name=Freecam

src/main/java/me/apollointhehouse/mixin/GameSettingsMixin.java

@@ -1,7 +1,6 @@
 package me.apollointhehouse.mixin;
 
 import me.apollointhehouse.options.FreecamOptions;
-import net.minecraft.client.gui.options.components.BooleanOptionComponent;
 import net.minecraft.client.input.InputDevice;
 import net.minecraft.client.option.GameSettings;
 import net.minecraft.client.option.KeyBinding;
@@ -24,7 +23,6 @@ public class GameSettingsMixin implements FreecamOptions {
 		return freecamBind;
 	}
 
-
 	@Override
 	public @NotNull OptionBoolean getFreecam() {
 		return freecam;

src/main/java/me/apollointhehouse/mixin/GamemodeAccessor.java

@@ -0,0 +1,11 @@
+package me.apollointhehouse.mixin;
+
+import net.minecraft.core.player.gamemode.Gamemode;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.gen.Accessor;
+
+@Mixin(value = Gamemode.class, remap = false)
+public interface GamemodeAccessor {
+	@Accessor("canInteract")
+	void setCanInteract(boolean canInteract);
+}

src/main/java/me/apollointhehouse/mixin/ScreenMainMenuMixin.java

@@ -1,64 +1,25 @@
 package me.apollointhehouse
 
-import me.apollointhehouse.options.FreecamOptions
-import me.apollointhehouse.raywire.Raywire
-import me.apollointhehouse.raywire.api.EventHandler
-import me.apollointhehouse.raywire.api.event.core.network.PacketEvent
-import net.fabricmc.api.ModInitializer
-import net.minecraft.client.Minecraft
-import net.minecraft.client.gui.options.components.BooleanOptionComponent
-import net.minecraft.client.gui.options.data.OptionsPages
-import net.minecraft.core.net.packet.PacketMovePlayer
-import net.minecraft.core.player.gamemode.Gamemode
-import net.minecraft.core.util.phys.Vec3
-import org.slf4j.Logger
+import me.apollointhehouse.net.client.ClientLogic
+import me.apollointhehouse.net.server.ServerLogic
+import me.apollointhehouse.raywire.Raywire.registry
 import org.slf4j.LoggerFactory
-import turniplabs.halplibe.util.ClientStartEntrypoint
-
-object Freecam : ModInitializer, ClientStartEntrypoint {
-	const val MOD_ID: String = "freecam"
-	@JvmField val LOGGER: Logger = LoggerFactory.getLogger(MOD_ID)
-
-	private val options by lazy { Minecraft.getMinecraft().gameSettings as FreecamOptions }
-	private var toggled = false
-	private var oldPos = Vec3.getPermanentVec3(0.0,0.0,0.0)
-	private var oldGamemode = Gamemode.spectator
-
-	override fun onInitialize() {
-		LOGGER.info("Freecam initialized.")
-
-		Raywire.registry.subscribe(this)
-	}
-
-	override fun beforeClientStart() {
-	}
-
-	override fun afterClientStart() {
-		options.freecam.addCallback { option ->
-			val mc = Minecraft.getMinecraft()
-			val player = mc.thePlayer
-
-			if (!option.value) {
-				player.gamemode = oldGamemode
-				player.moveTo(oldPos.x,oldPos.y,oldPos.z, player.xRot, player.yRot)
-
-				return@addCallback
-			}
-
-			oldGamemode = player.gamemode
-			oldPos = Vec3.getPermanentVec3(player.x, player.bb.minY, player.z)
-			mc.thePlayer.gamemode = Gamemode.spectator
+import turniplabs.halplibe.helper.EnvironmentHelper
+import turniplabs.halplibe.util.GameStartEntrypoint
+
+object Freecam : GameStartEntrypoint {
+	const val MOD_ID = "freecam"
+	private val logger = LoggerFactory.getLogger(MOD_ID)
+
+	override fun afterGameStart() {
+		if (EnvironmentHelper.isServerEnvironment()) {
+			logger.info("Freecam server started.")
+			registry.subscribe(ServerLogic())
+		} else {
+			logger.info("Freecam client started.")
+			registry.subscribe(ClientLogic())
 		}
-
-		OptionsPages.GENERAL.withComponent(BooleanOptionComponent(options.freecam))
 	}
 
-
-	@EventHandler
-	fun onSendPacket(event: PacketEvent.Send) {
-		if (event.packet !is PacketMovePlayer) return
-		if (!toggled) return
-
-		event.cancel()
-	}
+	override fun beforeGameStart() {}
 }

src/main/kotlin/me/apollointhehouse/Freecam.kt

@@ -0,0 +1,50 @@
+@file:OptIn(ExperimentalStdlibApi::class)
+package me.apollointhehouse.modules
+
+import me.apollointhehouse.mixin.GamemodeAccessor
+import me.apollointhehouse.options.FreecamOptions
+import me.apollointhehouse.raywire.api.EventHandler
+import me.apollointhehouse.raywire.api.event.core.network.PacketEvent
+import net.minecraft.client.gui.options.components.BooleanOptionComponent
+import net.minecraft.client.gui.options.data.OptionsPages
+import net.minecraft.core.net.packet.PacketMovePlayer
+import net.minecraft.core.util.phys.Vec3
+import org.slf4j.LoggerFactory
+
+object FreecamMod : Module() {
+	private var oldPos = Vec3.getPermanentVec3(0.0,0.0,0.0)
+
+	init {
+		val options = mc.gameSettings as FreecamOptions
+
+		options.freecam.addCallback { option ->
+			if (!option.value) {
+				disable()
+				return@addCallback
+			}
+			enable()
+		}
+
+		OptionsPages.GENERAL.withComponent(BooleanOptionComponent(options.freecam))
+	}
+
+	override fun onEnable() {
+		oldPos = Vec3.getPermanentVec3(player.x, player.bb.minY, player.z)
+		player.noPhysics = true
+		(player.gamemode as GamemodeAccessor).setCanInteract(false)
+	}
+
+	override fun onDisable() {
+		player.moveTo(oldPos.x,oldPos.y,oldPos.z, 0f, 0f)
+
+		player.noPhysics = false
+		(player.gamemode as GamemodeAccessor).setCanInteract(true)
+	}
+
+	@EventHandler
+	fun onSendPacket(event: PacketEvent.Send) {
+		if (event.packet is PacketMovePlayer) event.cancel()
+	}
+
+	private val logger = LoggerFactory.getLogger(FreecamMod::class.java)
+}

src/main/kotlin/me/apollointhehouse/modules/FreecamMod.kt

@@ -0,0 +1,32 @@
+package me.apollointhehouse.modules
+
+import me.apollointhehouse.raywire.Raywire.registry
+import net.minecraft.client.Minecraft
+import net.minecraft.client.entity.player.PlayerLocal
+
+abstract class Module {
+	var enabled = false
+		private set
+
+	protected val mc: Minecraft = Minecraft.getMinecraft()
+	protected val player: PlayerLocal get() = mc.thePlayer
+
+	open fun onEnable() {}
+	open fun onDisable() {}
+
+	fun disable() {
+		if (!enabled) return
+
+		enabled = false
+		registry.unsubscribe(this)
+		onDisable()
+	}
+
+	fun enable() {
+		if (enabled) return
+
+		enabled = true
+		onEnable()
+		registry.subscribe(this)
+	}
+}

src/main/kotlin/me/apollointhehouse/modules/Module.kt

@@ -0,0 +1,45 @@
+package me.apollointhehouse.net.client
+
+import me.apollointhehouse.modules.FreecamMod
+import me.apollointhehouse.raywire.api.EventHandler
+import me.apollointhehouse.raywire.api.event.core.network.PacketEvent
+import net.minecraft.client.Minecraft
+import net.minecraft.core.net.packet.PacketAESSendKey
+import net.minecraft.core.net.packet.PacketCustomPayload
+import org.slf4j.LoggerFactory
+
+class ClientLogic {
+	@EventHandler
+	fun onLogin(event: PacketEvent.Receive) {
+		if (event.packet !is PacketAESSendKey) return
+		FreecamMod.disable()
+
+		val mc = Minecraft.getMinecraft()
+
+		logger.info("Sending Freecam Request to server...")
+		mc.sendQueue.addToSendQueue(PacketCustomPayload("Freecam", byteArrayOf(0x00)))
+	}
+
+	@OptIn(ExperimentalStdlibApi::class)
+	@EventHandler
+	fun onCustomPayload(event: PacketEvent.Receive) {
+		val packet = event.packet as? PacketCustomPayload ?: return
+
+		if (packet.channel != "Freecam") return
+		if (packet.data.isEmpty()) return
+
+		when (val data = packet.data.first()) {
+			0x01.toByte() -> {
+				logger.info("Freecam Supported!")
+				FreecamMod
+			}
+			else -> {
+				logger.info("Unknown Freecam data received: ${data.toHexString()}")
+			}
+		}
+	}
+
+	companion object {
+		private val logger = LoggerFactory.getLogger(ClientLogic::class.java)
+	}
+}

src/main/kotlin/me/apollointhehouse/net/client/ClientLogic.kt

@@ -0,0 +1,37 @@
+package me.apollointhehouse.net.server
+
+import me.apollointhehouse.raywire.api.EventHandler
+import me.apollointhehouse.raywire.api.event.core.network.PacketEvent
+import net.minecraft.core.net.packet.PacketCustomPayload
+import net.minecraft.server.MinecraftServer
+import org.slf4j.LoggerFactory
+
+class ServerLogic {
+	@OptIn(ExperimentalStdlibApi::class)
+	@EventHandler
+	fun onCustomPayload(event: PacketEvent.Receive) {
+		val packet = event.packet as? PacketCustomPayload ?: return
+
+		if (packet.channel != "Freecam") return
+		if (packet.data.isEmpty()) return
+
+		when (val data = packet.data.first()) {
+			0x00.toByte() -> {
+				logger.info("Handling Freecam Request!")
+				MinecraftServer.getInstance().playerList.sendPacketToAllPlayers(
+					PacketCustomPayload(
+						"Freecam",
+						byteArrayOf(0x01)
+					)
+				)
+			}
+			else -> {
+				logger.info("Unknown Freecam data received: ${data.toHexString()}")
+			}
+		}
+	}
+
+	companion object {
+		private val logger = LoggerFactory.getLogger(ServerLogic::class.java)
+	}
+}