Skip to content

FIX: Prevents betterfirework from trying to start flying without an elytra or a firework. Shows a warning message to the user instead. #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emyfops merged 4 commits into from
Jan 27, 2026
Merged

FIX: Prevents betterfirework from trying to start flying without an elytra or a firework. Shows a warning message to the user instead. #227

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
39d5425
BetterFirework fix, no longer tries to start flying without elytra or…
KMatias123 Jan 26, 2026
0e6f58f
Use API instead of iterating over inventory, variable with getter ins…
KMatias123 Jan 26, 2026
8b782f6
No need to use mc here.
KMatias123 Jan 26, 2026
5f374cb
Styling changes.
KMatias123 Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
301 changes: 160 additions & 141 deletions src/main/kotlin/com/lambda/module/modules/movement/BetterFirework.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ import com.lambda.interaction.material.StackSelection.Companion.selectStack
import com.lambda.module.Module
import com.lambda.module.tag.ModuleTag
import com.lambda.threading.runSafe
import com.lambda.util.Communication.warn
import com.lambda.util.KeyCode
import com.lambda.util.Mouse
import com.lambda.util.player.SlotUtils.hotbarAndInventoryStacks
import com.lambda.util.player.SlotUtils.hotbarStacks
import net.minecraft.client.network.ClientPlayerEntity
import net.minecraft.entity.EquipmentSlot
import net.minecraft.entity.effect.StatusEffects
import net.minecraft.item.Items
import net.minecraft.network.packet.c2s.play.ClientCommandC2SPacket
Expand All @@ -43,35 +45,52 @@ import net.minecraft.util.Hand
import net.minecraft.util.hit.HitResult

object BetterFirework : Module(
name = "BetterFirework",
description = "Automatic takeoff with fireworks",
tag = ModuleTag.MOVEMENT,
name = "BetterFirework",
description = "Automatic takeoff with fireworks",
tag = ModuleTag.MOVEMENT,
) {
private var activateButton by setting("Activate Key", Bind(0, 0, Mouse.Middle.ordinal), "Button to activate Firework")
.onPress {
if (takeoffState != TakeoffState.None) return@onPress // Prevent using multiple times
// If already gliding use another firework
if (player.canOpenElytra || player.isGliding) takeoffState = TakeoffState.StartFlying
else if (player.canTakeoff) takeoffState = TakeoffState.Jumping
}
private var midFlightActivationKey by setting("Mid-Flight Activation Key", Bind.EMPTY, "Firework use key for mid flight activation")
.onPress { if (player.isGliding) takeoffState = TakeoffState.StartFlying }
private var middleClickCancel by setting("Middle Click Cancel", false, description = "Cancel pick block action on middle mouse click") { activateButton.key != KeyCode.Unbound.code }
private var fireworkInteract by setting("Right Click Fly", true, "Automatically start flying when right clicking fireworks")
private var fireworkInteractCancel by setting("Right Click Cancel", false, "Cancel block interactions while holding fireworks") { fireworkInteract }

private var clientSwing by setting("Swing", true, "Swing hand client side")
private var invUse by setting("Inventory", true, "Use fireworks from inventory") { activateButton.key != KeyCode.Unbound.code }

private var takeoffState = TakeoffState.None

val ClientPlayerEntity.canTakeoff: Boolean
get() = isOnGround || canOpenElytra

val ClientPlayerEntity.canOpenElytra: Boolean
get() = !abilities.flying && !isClimbing && !isGliding && !isTouchingWater && !isOnGround && !hasVehicle() && !hasStatusEffect(StatusEffects.LEVITATION)

init {
private var activateButton by setting("Activate Key", Bind(0, 0, Mouse.Middle.ordinal), "Button to activate Firework")
.onPress {
if (!player.isElytraEquipped) {
warn("You need to equip an elytra to use this module!")
return@onPress
}
if (!player.hasFireworks) {
warn("You need to have fireworks in your inventory to use this module!")
return@onPress
}
// Prevent using multiple times
if (takeoffState != TakeoffState.None) return@onPress
// If already gliding use another firework
if (player.canOpenElytra || player.isGliding) takeoffState = TakeoffState.StartFlying
else if (player.canTakeoff) takeoffState = TakeoffState.Jumping
}
private var midFlightActivationKey by setting("Mid-Flight Activation Key", Bind.EMPTY, "Firework use key for mid flight activation")
.onPress { if (player.isGliding) takeoffState = TakeoffState.StartFlying }
private var middleClickCancel by setting("Middle Click Cancel", false, description = "Cancel pick block action on middle mouse click") { activateButton.key != KeyCode.Unbound.code }
private var fireworkInteract by setting("Right Click Fly", true, "Automatically start flying when right clicking fireworks")
private var fireworkInteractCancel by setting("Right Click Cancel", false, "Cancel block interactions while holding fireworks") { fireworkInteract }

private var clientSwing by setting("Swing", true, "Swing hand client side")
private var invUse by setting("Inventory", true, "Use fireworks from inventory") { activateButton.key != KeyCode.Unbound.code }

private var takeoffState = TakeoffState.None

val ClientPlayerEntity.isElytraEquipped: Boolean
get() = inventory.equipment.get(EquipmentSlot.CHEST)?.item == Items.ELYTRA

val ClientPlayerEntity.hasFireworks: Boolean
get() = selectStack { isItem(Items.FIREWORK_ROCKET) }
.filterStacks(inventory.mainStacks)
.isNotEmpty() || offHandStack.item == Items.FIREWORK_ROCKET

val ClientPlayerEntity.canTakeoff: Boolean
get() = (isOnGround || canOpenElytra) && isElytraEquipped && hasFireworks

val ClientPlayerEntity.canOpenElytra: Boolean
get() = !abilities.flying && !isClimbing && !isGliding && !isTouchingWater && !isOnGround && !hasVehicle() && !hasStatusEffect(StatusEffects.LEVITATION)

init {
setDefaultAutomationConfig {
applyEdits {
hideAllGroupsExcept(hotbarConfig, inventoryConfig)
Expand All @@ -80,117 +99,117 @@ object BetterFirework : Module(
}
}

listen<TickEvent.Pre> {
when (takeoffState) {
TakeoffState.None -> {}

TakeoffState.Jumping -> {
player.jump()
takeoffState = TakeoffState.StartFlying
}

TakeoffState.StartFlying -> {
if (player.canOpenElytra) {
player.startGliding()
connection.sendPacket(ClientCommandC2SPacket(player, ClientCommandC2SPacket.Mode.START_FALL_FLYING))
}
startFirework(invUse)
takeoffState = TakeoffState.None
}
}
}
}

/**
* Returns true if the mc item interaction should be canceled
*/
@JvmStatic
fun onInteract() =
runSafe {
when {
!fireworkInteract ||
player.inventory.selectedStack?.item != Items.FIREWORK_ROCKET ||
player.isGliding || // No need to do special magic if we are already holding fireworks and flying
(mc.crosshairTarget != null && mc.crosshairTarget!!.type != HitResult.Type.MISS && !fireworkInteractCancel) -> false
else -> {
mc.itemUseCooldown += 4
val cancelInteract = player.canTakeoff || fireworkInteractCancel
if (player.canTakeoff) {
takeoffState = TakeoffState.Jumping
} else if (player.canOpenElytra) {
takeoffState = TakeoffState.StartFlying
}
cancelInteract
}
}
} ?: false

/**
* Returns true when the pick interaction should be canceled.
*/
@JvmStatic
fun onPick() =
runSafe {
when {
(mc.crosshairTarget?.type == HitResult.Type.BLOCK && !middleClickCancel) ||
activateButton.mouse != mc.options.pickItemKey.boundKey.code ||
takeoffState != TakeoffState.None -> false // Prevent using multiple times
else -> middleClickCancel
}
} ?: false

fun SafeContext.sendSwing() {
if (clientSwing) {
player.swingHand(Hand.MAIN_HAND)
} else {
connection.sendPacket(HandSwingC2SPacket(Hand.MAIN_HAND))
}
}

/**
* Use a firework from the hotbar or inventory if possible.
* Return true if a firework has been used
*/
@JvmStatic
fun SafeContext.startFirework(silent: Boolean) {
val stack = selectStack(count = 1) { isItem(Items.FIREWORK_ROCKET) }

stack.bestItemMatch(player.hotbarStacks)
?.let {
val request = HotbarRequest(player.hotbarStacks.indexOf(it), this@BetterFirework, keepTicks = 0)
.submit(queueIfMismatchedStage = false)
if (request.done) {
interaction.interactItem(player, Hand.MAIN_HAND)
sendSwing()
}
return
}

if (!silent) return

stack.bestItemMatch(player.hotbarAndInventoryStacks)
?.let {
val swapSlotId = player.hotbarAndInventoryStacks.indexOf(it)
val hotbarSlotToSwapWith = player.hotbarStacks.find { slot -> slot.isEmpty }?.let { slot -> player.hotbarStacks.indexOf(slot) } ?: 8

inventoryRequest {
swap(swapSlotId, hotbarSlotToSwapWith)
action {
val request = HotbarRequest(hotbarSlotToSwapWith, this@BetterFirework, keepTicks = 0, nowOrNothing = true)
.submit(queueIfMismatchedStage = false)
if (request.done) {
interaction.interactItem(player, Hand.MAIN_HAND)
sendSwing()
}
}
swap(swapSlotId, hotbarSlotToSwapWith)
}.submit()
}
}

enum class TakeoffState {
None,
Jumping,
StartFlying
}
listen<TickEvent.Pre> {
when (takeoffState) {
TakeoffState.None -> {}

TakeoffState.Jumping -> {
player.jump()
takeoffState = TakeoffState.StartFlying
}

TakeoffState.StartFlying -> {
if (player.canOpenElytra) {
player.startGliding()
connection.sendPacket(ClientCommandC2SPacket(player, ClientCommandC2SPacket.Mode.START_FALL_FLYING))
}
startFirework(invUse)
takeoffState = TakeoffState.None
}
}
}
}

/**
* Returns true if the mc item interaction should be canceled
*/
@JvmStatic
fun onInteract() =
runSafe {
when {
!fireworkInteract ||
player.inventory.selectedStack?.item != Items.FIREWORK_ROCKET ||
player.isGliding || // No need to do special magic if we are already holding fireworks and flying
(mc.crosshairTarget != null && mc.crosshairTarget!!.type != HitResult.Type.MISS && !fireworkInteractCancel) -> false
else -> {
mc.itemUseCooldown += 4
val cancelInteract = player.canTakeoff || fireworkInteractCancel
if (player.canTakeoff) {
takeoffState = TakeoffState.Jumping
} else if (player.canOpenElytra) {
takeoffState = TakeoffState.StartFlying
}
cancelInteract
}
}
} ?: false

/**
* Returns true when the pick interaction should be canceled.
*/
@JvmStatic
fun onPick() =
runSafe {
when {
(mc.crosshairTarget?.type == HitResult.Type.BLOCK && !middleClickCancel) ||
activateButton.mouse != mc.options.pickItemKey.boundKey.code ||
takeoffState != TakeoffState.None -> false // Prevent using multiple times
else -> middleClickCancel
}
} ?: false

fun SafeContext.sendSwing() {
if (clientSwing) {
player.swingHand(Hand.MAIN_HAND)
} else {
connection.sendPacket(HandSwingC2SPacket(Hand.MAIN_HAND))
}
}

/**
* Use a firework from the hotbar or inventory if possible.
* Return true if a firework has been used
*/
@JvmStatic
fun SafeContext.startFirework(silent: Boolean) {
val stack = selectStack(count = 1) { isItem(Items.FIREWORK_ROCKET) }

stack.bestItemMatch(player.hotbarStacks)
?.let {
val request = HotbarRequest(player.hotbarStacks.indexOf(it), this@BetterFirework, keepTicks = 0)
.submit(queueIfMismatchedStage = false)
if (request.done) {
interaction.interactItem(player, Hand.MAIN_HAND)
sendSwing()
}
return
}

if (!silent) return

stack.bestItemMatch(player.hotbarAndInventoryStacks)
?.let {
val swapSlotId = player.hotbarAndInventoryStacks.indexOf(it)
val hotbarSlotToSwapWith = player.hotbarStacks.find { slot -> slot.isEmpty }?.let { slot -> player.hotbarStacks.indexOf(slot) } ?: 8

inventoryRequest {
swap(swapSlotId, hotbarSlotToSwapWith)
action {
val request = HotbarRequest(hotbarSlotToSwapWith, this@BetterFirework, keepTicks = 0, nowOrNothing = true)
.submit(queueIfMismatchedStage = false)
if (request.done) {
interaction.interactItem(player, Hand.MAIN_HAND)
sendSwing()
}
}
swap(swapSlotId, hotbarSlotToSwapWith)
}.submit()
}
}

enum class TakeoffState {
None,
Jumping,
StartFlying
}
}