Readme, fix enable.

Author: noobanidus

README.md

@@ -0,0 +1,21 @@
+# Lag Generator
+
+This is a simple, brute-force "lag" generator for Minecraft servers.
+
+It is configured via game rules.
+
+- lag_generator_enableLag, true or false (false by default)
+- lag_generator_serverPreTickLag, integer value of lag (in milliseconds) that should be created in each server pre-tick (default 80)
+- lag_generator_serverPostTickLag, integer value of lag (in milliseconds) that should be created in each server post-tick (default 80)
+- lag_generator_entityTickLag, integer value of lag (in milliseconds) that should be created in each entity base tick (default 10)
+
+Lag comes in three flavours:
+
+- Server Pre-Tick lag is added with `Thread.sleep` at the start of each server tick (after the tick count has been incremented)
+- Server Post-Tick lag is added with `Thread.sleep` at the end of each server tick (after the profiler has been popped)
+
+Both of these types of lag statically decrease TPS.
+
+- Entity tick lag is added with `Thread.sleep` in the `Entity::baseTick` method. 
+
+This type of lag is cumulative depending on the number of loaded entities.

common/src/main/java/noobanidus/mods/laggenerator/common/rules/LagGameRules.java

@@ -24,6 +24,6 @@ public static void init () {
     SERVER_PRE_TICK_LAG = AccessorMixinGameRules.LagGenerator$invokeRegister("lag_generator_serverPreTickLag", GameRules.Category.UPDATES, AccessorMixinGameRules$IntegerValue.LagGenerator$invokeCreate(80, 0, Integer.MAX_VALUE, (a, b) -> {}));
     SERVER_POST_TICK_LAG = AccessorMixinGameRules.LagGenerator$invokeRegister("lag_generator_serverPostTickLag", GameRules.Category.UPDATES, AccessorMixinGameRules$IntegerValue.LagGenerator$invokeCreate(80, 0, Integer.MAX_VALUE, (a, b) -> {}));
     ENTITY_TICK_LAG = AccessorMixinGameRules.LagGenerator$invokeRegister("lag_generator_entityTickLag", GameRules.Category.UPDATES, AccessorMixinGameRules$IntegerValue.LagGenerator$invokeCreate(10, 0, Integer.MAX_VALUE, (a, b) -> {}));
-    ENABLE_LAG_GENERATOR = AccessorMixinGameRules.LagGenerator$invokeRegister("enable_lag_generator", GameRules.Category.UPDATES, AccessorMixinGameRules$BooleanValue.LagGenerator$invokeCreate(false, (a, b) -> {}));
+    ENABLE_LAG_GENERATOR = AccessorMixinGameRules.LagGenerator$invokeRegister("lag_generator_enableLag", GameRules.Category.UPDATES, AccessorMixinGameRules$BooleanValue.LagGenerator$invokeCreate(false, (a, b) -> {}));
   }
 }