Version 1.3: add an option to force disable slowdown on clients

Author: Beaness

.idea/checkstyle-idea.xml

@@ -24,11 +24,16 @@ Due to the sprint state being stored in a bitmask the plugin can't always cancel
 
 Doing this fix should make hit slowdown **less latency** dependant.
 
-**Warning:** This plugin will make hit slowdown happen completely different to most servers (To compare: minemen.club has fixed this issue partly by not doing setSprinting(false) internally, it still has the other issue, of when the client sends START_SPRINTING / STOP_SPRINTING)
+**Warning:** This plugin will make hit slowdown happen completely different to most servers
 
 ## Attribute
-Since version 1.1 BetterSlowdown also cancels "useless" attribute packets which apply / remove the sprint modifier, this is handled client side and the server should not try to override this. 
+BetterSlowdown also cancels "useless" attribute packets which apply / remove the sprint modifier, this is handled client side and the server should not try to override this. 
+
+## No slowdown
+You can also use the plugin to disable hit slowdown by spamming metadata sprinting packets to the client. (Note if a client lag spikes its possible they miss the packet and still have slowdown hits)
+
+**Warning:** this breaks dynamic fov when you toggle your sprint
 
 ## Dependencies
 
-This plugin uses, and depends on [PacketEvents](https://github.com/retrooper/packetevents)
+This plugin uses, and depends on [PacketEvents](https://github.com/retrooper/packetevents)

README.md

@@ -3,7 +3,7 @@ plugins {
 }
 
 group = "me.beanes"
-version = "1.2"
+version = "1.3"
 
 
 repositories {
@@ -20,13 +20,17 @@ repositories {
         name = "sonatype"
         url = uri("https://oss.sonatype.org/content/groups/public/")
     }
+    maven {
+        url = uri("https://maven.elmakers.com/repository")
+    }
 }
 
 dependencies {
     compileOnly("org.spigotmc:spigot-api:1.8.8-R0.1-SNAPSHOT")
-    compileOnly("com.github.retrooper:packetevents-spigot:2.7.0")
+    compileOnly("com.github.retrooper:packetevents-spigot:2.11.2")
+    compileOnly("io.netty:netty-all:4.1.72.Final")
 }
 
 tasks.test {
     useJUnitPlatform()
-}
+}

build.gradle.kts

@@ -3,12 +3,13 @@
 import com.github.retrooper.packetevents.PacketEvents;
 import com.github.retrooper.packetevents.event.PacketListenerCommon;
 import com.github.retrooper.packetevents.event.PacketListenerPriority;
-import me.beanes.betterslowdown.listener.FilterListener;
+import me.beanes.betterslowdown.listener.PacketListener;
 import org.bukkit.plugin.java.JavaPlugin;
 
 public class BetterSlowdown extends JavaPlugin {
     private FallbackMode mode = FallbackMode.SPRINT;
     private boolean alwaysAddSprint = false;
+    private int forceSlowdown = -1;
     private PacketListenerCommon listener;
 
     public FallbackMode getMode() {
@@ -19,9 +20,13 @@ public boolean isAlwaysAddSprint() {
         return alwaysAddSprint;
     }
 
+    public int getForceSlowdown() {
+        return forceSlowdown;
+    }
+
     @Override
     public void onLoad() {
-        listener = PacketEvents.getAPI().getEventManager().registerListener(new FilterListener(this), PacketListenerPriority.LOWEST);
+        listener = PacketEvents.getAPI().getEventManager().registerListener(new PacketListener(this), PacketListenerPriority.LOWEST);
     }
 
     @Override
@@ -31,6 +36,7 @@ public void onEnable() {
         try {
             mode = FallbackMode.valueOf(getConfig().getString("mode").toUpperCase());
             alwaysAddSprint = getConfig().getBoolean("always-add-sprint");
+            forceSlowdown = getConfig().getInt("force-slowdown",  -1);
         } catch (Exception ex) {
             mode = FallbackMode.SERVER;
             getLogger().info("Failed to load config due to error");

src/main/java/me/beanes/betterslowdown/BetterSlowdown.java

@@ -1,11 +1,15 @@
 package me.beanes.betterslowdown.data;
 
+import com.github.retrooper.packetevents.protocol.player.User;
+
 public class PlayerData {
+    private final User user;
     private byte lastUsefulBitmask;
     private double lastSpeed;
     private boolean clientSprintingState;
 
-    public PlayerData() {
+    public PlayerData(User user) {
+        this.user = user;
         this.reset();
     }
 
@@ -15,6 +19,10 @@ public void reset() {
         this.clientSprintingState = false;
     }
 
+    public User getUser() {
+        return user;
+    }
+
     public double getLastSpeed() {
         return lastSpeed;
     }

src/main/java/me/beanes/betterslowdown/data/PlayerData.java

@@ -26,10 +26,14 @@ public PlayerData get(User user) {
         PlayerData data = cache.get(user);
 
         if (data == null) {
-            data = new PlayerData();
+            data = new PlayerData(user);
             cache.put(user, data);
         }
 
         return data;
     }
+
+    public Collection<PlayerData> getAll() {
+        return cacheThreadLocal.get().values();
+    }
 }

src/main/java/me/beanes/betterslowdown/data/PlayerDataManager.java

@@ -0,0 +1,37 @@
+package me.beanes.betterslowdown.listener;
+
+import com.github.retrooper.packetevents.protocol.ConnectionState;
+import com.github.retrooper.packetevents.protocol.entity.data.EntityData;
+import com.github.retrooper.packetevents.protocol.entity.data.EntityDataTypes;
+import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerEntityMetadata;
+import io.netty.channel.EventLoop;
+import me.beanes.betterslowdown.data.PlayerData;
+import me.beanes.betterslowdown.data.PlayerDataManager;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
+
+public class ForceSlowdownUtil {
+    private static Set<EventLoop> EVENTLOOP_DONE = new HashSet<>();
+
+    public static void repeatInEventLoop(PlayerDataManager manager, EventLoop eventLoop, int repeatTime) {
+        if (EVENTLOOP_DONE.add(eventLoop)) {
+            eventLoop.scheduleAtFixedRate(() -> {
+                for (PlayerData data : manager.getAll()) {
+                    sendSlowdown(data);
+                }
+            }, 0, repeatTime, TimeUnit.MILLISECONDS);
+        }
+    }
+
+    private static void sendSlowdown(PlayerData data) {
+        if (data.getUser().getName() != null && data.getUser().getConnectionState() == ConnectionState.PLAY) { // Bit of a hack :/
+            List<EntityData<?>> forcedNoSprint = Collections.singletonList(new EntityData<>(0, EntityDataTypes.BYTE, (byte) data.getLastUsefulBitmask()));
+            WrapperPlayServerEntityMetadata wrapper = new WrapperPlayServerEntityMetadata(data.getUser().getEntityId(), forcedNoSprint);
+            data.getUser().sendPacketSilently(wrapper);
+        }
+    }
+}

src/main/java/me/beanes/betterslowdown/listener/ForceSlowdownUtil.java

@@ -8,6 +8,7 @@
 import com.github.retrooper.packetevents.wrapper.play.client.WrapperPlayClientEntityAction;
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerEntityMetadata;
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerUpdateAttributes;
+import io.netty.channel.Channel;
 import me.beanes.betterslowdown.BetterSlowdown;
 import me.beanes.betterslowdown.FallbackMode;
 import me.beanes.betterslowdown.data.PlayerData;
@@ -16,7 +17,7 @@
 import java.util.Iterator;
 import java.util.UUID;
 
-public class FilterListener implements PacketListener {
+public class PacketListener implements com.github.retrooper.packetevents.event.PacketListener {
     private static final UUID SPRINT_MODIFIER_UUID = UUID.fromString("662A6B8D-DA3E-4C1C-8813-96EA6097278D");
     private static final WrapperPlayServerUpdateAttributes.PropertyModifier SPRINT_MODIFIER = new WrapperPlayServerUpdateAttributes.PropertyModifier(
             SPRINT_MODIFIER_UUID,
@@ -26,7 +27,7 @@ public class FilterListener implements PacketListener {
     private final BetterSlowdown plugin;
     private final PlayerDataManager manager;
 
-    public FilterListener(BetterSlowdown plugin) {
+    public PacketListener(BetterSlowdown plugin) {
         this.plugin = plugin;
         this.manager = new PlayerDataManager();
     }
@@ -53,11 +54,10 @@ public void onPacketSend(PacketSendEvent event) {
         // Listen for metadata packets
         if (event.getPacketType() == PacketType.Play.Server.ENTITY_METADATA) {
             WrapperPlayServerEntityMetadata wrapper = new WrapperPlayServerEntityMetadata(event);
-            User user = event.getUser();
 
             // Only check metadata packets about the player itself
             if (wrapper.getEntityId() == event.getUser().getEntityId()) {
-                Iterator<EntityData> iterator = wrapper.getEntityMetadata().iterator();
+                Iterator<EntityData<?>> iterator = wrapper.getEntityMetadata().iterator();
 
                 while (iterator.hasNext()) {
                     EntityData entityData = iterator.next();
@@ -155,11 +155,19 @@ public void onPacketSend(PacketSendEvent event) {
 
     @Override
     public void onUserConnect(UserConnectEvent event) {
-        manager.cache(event.getUser(), new PlayerData());
+        User user = event.getUser();
+        manager.cache(user, new PlayerData(user));
+
+        int repeatTimeNoSlowdown = plugin.getForceSlowdown();
+
+        if (repeatTimeNoSlowdown >= 1) {
+            Channel channel = (Channel) user.getChannel();
+            ForceSlowdownUtil.repeatInEventLoop(manager, channel.eventLoop(), repeatTimeNoSlowdown);
+        }
     }
 
     @Override
     public void onUserDisconnect(UserDisconnectEvent event) {
         manager.remove(event.getUser());
     }
-}
+}

…terslowdown/listener/FilterListener.java …terslowdown/listener/PacketListener.javasrc/main/java/me/beanes/betterslowdown/listener/FilterListener.java renamed to src/main/java/me/beanes/betterslowdown/listener/PacketListener.java src/main/java/me/beanes/betterslowdown/listener/FilterListener.java renamed to src/main/java/me/beanes/betterslowdown/listener/PacketListener.java

@@ -21,3 +21,11 @@ mode: CLIENT
 # This is useful for HCF servers when you get speed 3 / speed 2, and your sprint suddenly disappears
 # Worst case scenario, this can cause OmniSprint due to using client state
 always-add-sprint: false
+
+# Force no slowdown
+# This features allows you to completely disable hit slowdown by spamming packets to the client
+# The setting allows you to configure how often this "force no slowdown" packet should be sent
+# You want this packet to arrive each client so in ideal circumstances with no lag spikes a 50 ms delay between packet send is perfect (put 50 in the option below)
+# WARNING: this option breaks dynamic fov for sprinting, players their fov will not update properly anymore while this is enabled
+# Use -1 to disable this feature
+force-slowdown: -1

src/main/resources/config.yml

@@ -1,5 +1,5 @@
 name: BetterSlowdown
-version: 1.1
+version: 1.3
 main: me.beanes.betterslowdown.BetterSlowdown
 author: Beanes
 description: Fixes server/network issues related to hit slowdown