Revision 237

README.md

@@ -1,7 +1,7 @@
 # RSProt
 
 [![GitHub Actions][actions-badge]][actions] [![MIT license][mit-badge]][mit]
-[![OldSchool - 221 - 236 (Alpha)](https://img.shields.io/badge/OldSchool-221--236_(Alpha)-9a1abd)](https://github.com/blurite/rsprot/tree/master/protocol/osrs-236/osrs-236-api/src/main/kotlin/net/rsprot/protocol/api)
+[![OldSchool - 221 - 237 (Alpha)](https://img.shields.io/badge/OldSchool-221--237_(Alpha)-9a1abd)](https://github.com/blurite/rsprot/tree/master/protocol/osrs-237/osrs-237-api/src/main/kotlin/net/rsprot/protocol/api)
 
 ## Status
 > [!NOTE]
@@ -16,7 +16,7 @@ In order to add it to your server, add the below line under dependencies
 in your build.gradle.kts.
 
 ```kts
-implementation("net.rsprot:osrs-236-api:1.0.0-ALPHA-20260315")
+implementation("net.rsprot:osrs-237-api:1.0.0-ALPHA-20260325")
 ```
 
 An in-depth tutorial on how to implement it will be added into this read-me
@@ -32,12 +32,12 @@ other revisions are welcome, but will not be provided by default.
 - Java 11
 
 ## Supported Versions
-This library currently supports revision 221-236 OldSchool desktop clients.
+This library currently supports revision 221-237 OldSchool desktop clients.
 
 ## Quick Guide
 This section covers a quick guide for how to use the protocol after implementing
 the base API. It is not a guide for the base API itself, that will come in the
-future. This specific quick guide refers to revision 236. Revisions older
+future. This specific quick guide refers to revision 237. Revisions older
 than 235 have a significantly different API and will not be explored here.
 It is recommented you upgrade to latest, or view an older readme in history.
 
@@ -119,7 +119,7 @@ for (worldInfoPackets in infoPackets.activeWorlds) {
     packets.send(worldInfoPackets.activeWorld)
 
 	// If the world entity is newly added in this cycle, make sure to send the
-	// RebuildWorldEntityV2 packet for this world, to actually build the
+	// RebuildWorldEntityV3 packet for this world, to actually build the
 	// map behind the world entity.
     if (worldInfoPackets.added) {
         rebuildWorldEntity(worldInfoPackets.worldId)

WHATSNEW.md

@@ -1,5 +1,38 @@
 ## What's New?
 
+### Revision 237
+
+> [!IMPORTANT]
+> Root/toplevel world id changed from -1 to 0 in this revision.
+> Users must make sure their serverside code is using the new constant.
+> If you relied on any of the ROOT_WORLD constants in classes such as
+> WorldEntityInfo, you should be fine as-is.
+
+#### Additions
+- RESUME_P_COUNTDIALOG_LONG added.
+- RUNCLIENTSCRIPT supports `long` data type via 'Ï' char code.
+- IF_SETMODEL_V2 added, supporting g4() for models.
+- Obj customisation section in appearance extended info uses g4() for models.
+- Hitmarks and headbars separated into two individual extended infos.
+  - Hitmarks no longer support soaking.
+  - Hitmarks now have a 'limit' property, defining the maximum number of hitmarks that can render at once. The default is 4, the upper limit is 20.
+- NPC head and body customisation new variants that use g4() for models.
+- OPLOC*_V2 packets, supporting subops.
+- OPNPC*_V2 packets, supporting subops.
+- OPOBJ*_V2 packets, supporting subops.
+- REBUILD_NORMAL_V2 which removes XTEA support.
+- REBUILD_REGION_V2 which removes XTEA support.
+- REBUILD_WORLDENTITY_V4 which removes XTEA support.
+
+#### Removals
+- UPDATE_REBOOT_TIMER_V1
+- SET_MAP_FLAG_V1
+- CAM_MOVETO_V1
+- CAM_LOOKAT_V1
+- CAM_MOVETO_CYCLES_V1
+- CAM_MOVETO_ARC_V1
+- WORLDENTITY_INFO_V6
+
 ### Revision 236
 Revision 236 brings a handful of new variants of existing packets.
 

build.gradle.kts

@@ -16,7 +16,7 @@ plugins {
 
 allprojects {
     group = "net.rsprot"
-    version = "1.0.0-ALPHA-20260315"
+    version = "1.0.0-ALPHA-20260325"
 
     repositories {
         mavenCentral()

protocol/osrs-229/osrs-229-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt → protocol/osrs-225/osrs-225-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt

@@ -18,6 +18,7 @@ public class RebuildWorldEntityV2Encoder : MessageEncoder<RebuildWorldEntityV2>
         buffer: JagByteBuf,
         message: RebuildWorldEntityV2,
     ) {
+        buffer.p2(message.index)
         buffer.p2(message.baseX)
         buffer.p2(message.baseZ)
         encodeRegion(buffer, message.zones)

protocol/osrs-225/osrs-225-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/DesktopGameMessageEncoderRepository.kt

@@ -61,7 +61,7 @@ import net.rsprot.protocol.game.outgoing.codec.logout.LogoutTransferEncoder
 import net.rsprot.protocol.game.outgoing.codec.logout.LogoutWithReasonEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildNormalEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildRegionEncoder
-import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityEncoder
+import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityV2Encoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideLocOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideNpcOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideObjOpsEncoder
@@ -217,7 +217,7 @@ public object DesktopGameMessageEncoderRepository {
 
                 bindWithAlts(RebuildNormalEncoder(), RebuildLogin::class.java, RebuildNormal::class.java)
                 bind(RebuildRegionEncoder())
-                bind(RebuildWorldEntityEncoder())
+                bind(RebuildWorldEntityV2Encoder())
 
                 bind(VarpSmallEncoder())
                 bind(VarpLargeEncoder())

protocol/osrs-225/osrs-225-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProt.kt

@@ -103,7 +103,7 @@ public enum class GameServerProt(
     // Map packets
     REBUILD_NORMAL(GameServerProtId.REBUILD_NORMAL, Prot.VAR_SHORT),
     REBUILD_REGION(GameServerProtId.REBUILD_REGION, Prot.VAR_SHORT),
-    REBUILD_WORLDENTITY(GameServerProtId.REBUILD_WORLDENTITY, Prot.VAR_SHORT),
+    REBUILD_WORLDENTITY_V2(GameServerProtId.REBUILD_WORLDENTITY_V2, Prot.VAR_SHORT),
 
     // Varp packets
     VARP_SMALL(GameServerProtId.VARP_SMALL, 3),

protocol/osrs-225/osrs-225-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProtId.kt

@@ -132,7 +132,7 @@ internal object GameServerProtId {
     const val CLEAR_ENTITIES = 128
     const val SET_ACTIVE_WORLD = 129
     const val HIDEOBJOPS = 130
-    const val REBUILD_WORLDENTITY = 131
+    const val REBUILD_WORLDENTITY_V2 = 131
     const val HIDENPCOPS = 132
     const val HIDELOCOPS = 133
     const val WORLDENTITY_INFO = 134

protocol/osrs-227/osrs-227-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntity.kt → protocol/osrs-225/osrs-225-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntityV2.kt

@@ -13,7 +13,7 @@ import net.rsprot.protocol.message.OutgoingGameMessage
  * @property baseZ the absolute base z coordinate of the world entity in the instance land
  * @property zones the list of zones that will be built into the root world
  */
-public class RebuildWorldEntity private constructor(
+public class RebuildWorldEntityV2 private constructor(
     private val _index: UShort,
     private val _baseX: UShort,
     private val _baseZ: UShort,

protocol/osrs-230/osrs-230-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt → protocol/osrs-226/osrs-226-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt

@@ -18,6 +18,7 @@ public class RebuildWorldEntityV2Encoder : MessageEncoder<RebuildWorldEntityV2>
         buffer: JagByteBuf,
         message: RebuildWorldEntityV2,
     ) {
+        buffer.p2(message.index)
         buffer.p2(message.baseX)
         buffer.p2(message.baseZ)
         encodeRegion(buffer, message.zones)

protocol/osrs-226/osrs-226-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/DesktopGameMessageEncoderRepository.kt

@@ -61,7 +61,7 @@ import net.rsprot.protocol.game.outgoing.codec.logout.LogoutTransferEncoder
 import net.rsprot.protocol.game.outgoing.codec.logout.LogoutWithReasonEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildNormalEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildRegionEncoder
-import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityEncoder
+import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityV2Encoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideLocOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideNpcOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideObjOpsEncoder
@@ -223,7 +223,7 @@ public object DesktopGameMessageEncoderRepository {
 
                 bindWithAlts(RebuildNormalEncoder(), RebuildLogin::class.java, RebuildNormal::class.java)
                 bind(RebuildRegionEncoder())
-                bind(RebuildWorldEntityEncoder())
+                bind(RebuildWorldEntityV2Encoder())
 
                 bind(VarpSmallEncoder())
                 bind(VarpLargeEncoder())

protocol/osrs-226/osrs-226-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProt.kt

@@ -123,7 +123,7 @@ public enum class GameServerProt(
     // Map packets
     REBUILD_NORMAL(GameServerProtId.REBUILD_NORMAL, Prot.VAR_SHORT),
     REBUILD_REGION(GameServerProtId.REBUILD_REGION, Prot.VAR_SHORT),
-    REBUILD_WORLDENTITY(GameServerProtId.REBUILD_WORLDENTITY, Prot.VAR_SHORT),
+    REBUILD_WORLDENTITY_V2(GameServerProtId.REBUILD_WORLDENTITY_V2, Prot.VAR_SHORT),
 
     // Varp packets
     VARP_SMALL(GameServerProtId.VARP_SMALL, 3),

protocol/osrs-226/osrs-226-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProtId.kt

@@ -131,7 +131,7 @@ internal object GameServerProtId {
     const val MESSAGE_PRIVATE = 127
     const val RESET_INTERACTION_MODE = 128
     const val SET_NPC_UPDATE_ORIGIN = 129
-    const val REBUILD_WORLDENTITY = 130
+    const val REBUILD_WORLDENTITY_V2 = 130
     const val SET_ACTIVE_WORLD = 131
     const val CLEAR_ENTITIES = 132
     const val HIDEOBJOPS = 133

protocol/osrs-225/osrs-225-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntity.kt → protocol/osrs-226/osrs-226-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntityV2.kt

@@ -13,7 +13,7 @@ import net.rsprot.protocol.message.OutgoingGameMessage
  * @property baseZ the absolute base z coordinate of the world entity in the instance land
  * @property zones the list of zones that will be built into the root world
  */
-public class RebuildWorldEntity private constructor(
+public class RebuildWorldEntityV2 private constructor(
     private val _index: UShort,
     private val _baseX: UShort,
     private val _baseZ: UShort,

protocol/osrs-231/osrs-231-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt → protocol/osrs-227/osrs-227-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt

@@ -18,6 +18,7 @@ public class RebuildWorldEntityV2Encoder : MessageEncoder<RebuildWorldEntityV2>
         buffer: JagByteBuf,
         message: RebuildWorldEntityV2,
     ) {
+        buffer.p2(message.index)
         buffer.p2(message.baseX)
         buffer.p2(message.baseZ)
         encodeRegion(buffer, message.zones)

protocol/osrs-227/osrs-227-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/DesktopGameMessageEncoderRepository.kt

@@ -59,7 +59,7 @@ import net.rsprot.protocol.game.outgoing.codec.logout.LogoutTransferEncoder
 import net.rsprot.protocol.game.outgoing.codec.logout.LogoutWithReasonEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildNormalEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildRegionEncoder
-import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityEncoder
+import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityV2Encoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideLocOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideNpcOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideObjOpsEncoder
@@ -219,7 +219,7 @@ public object DesktopGameMessageEncoderRepository {
 
                 bindWithAlts(RebuildNormalEncoder(), RebuildLogin::class.java, RebuildNormal::class.java)
                 bind(RebuildRegionEncoder())
-                bind(RebuildWorldEntityEncoder())
+                bind(RebuildWorldEntityV2Encoder())
 
                 bind(VarpSmallEncoder())
                 bind(VarpLargeEncoder())

protocol/osrs-227/osrs-227-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProt.kt

@@ -92,7 +92,7 @@ public enum class GameServerProt(
     // Map packets
     REBUILD_NORMAL(GameServerProtId.REBUILD_NORMAL, Prot.VAR_SHORT),
     REBUILD_REGION(GameServerProtId.REBUILD_REGION, Prot.VAR_SHORT),
-    REBUILD_WORLDENTITY(GameServerProtId.REBUILD_WORLDENTITY, Prot.VAR_SHORT),
+    REBUILD_WORLDENTITY_V2(GameServerProtId.REBUILD_WORLDENTITY_V2, Prot.VAR_SHORT),
 
     // Varp packets
     VARP_SMALL(GameServerProtId.VARP_SMALL, 3),

protocol/osrs-227/osrs-227-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProtId.kt

@@ -25,7 +25,7 @@ internal object GameServerProtId {
     const val IF_SETNPCHEAD_ACTIVE = 21
     const val REBUILD_NORMAL = 22
     const val SERVER_TICK_END = 23
-    const val REBUILD_WORLDENTITY = 24
+    const val REBUILD_WORLDENTITY_V2 = 24
     const val UPDATE_RUNENERGY = 25
     const val VARCLAN_ENABLE = 26
     const val IF_SETNPCHEAD = 27

protocol/osrs-228/osrs-228-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntity.kt → protocol/osrs-227/osrs-227-model/src/main/kotlin/net/rsprot/protocol/game/outgoing/map/RebuildWorldEntityV2.kt

@@ -13,7 +13,7 @@ import net.rsprot.protocol.message.OutgoingGameMessage
  * @property baseZ the absolute base z coordinate of the world entity in the instance land
  * @property zones the list of zones that will be built into the root world
  */
-public class RebuildWorldEntity private constructor(
+public class RebuildWorldEntityV2 private constructor(
     private val _index: UShort,
     private val _baseX: UShort,
     private val _baseZ: UShort,

protocol/osrs-232/osrs-232-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt → protocol/osrs-228/osrs-228-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/codec/map/RebuildWorldEntityV2Encoder.kt

@@ -18,6 +18,7 @@ public class RebuildWorldEntityV2Encoder : MessageEncoder<RebuildWorldEntityV2>
         buffer: JagByteBuf,
         message: RebuildWorldEntityV2,
     ) {
+        buffer.p2(message.index)
         buffer.p2(message.baseX)
         buffer.p2(message.baseZ)
         encodeRegion(buffer, message.zones)

protocol/osrs-228/osrs-228-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/DesktopGameMessageEncoderRepository.kt

@@ -59,7 +59,7 @@ import net.rsprot.protocol.game.outgoing.codec.logout.LogoutTransferEncoder
 import net.rsprot.protocol.game.outgoing.codec.logout.LogoutWithReasonEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildNormalEncoder
 import net.rsprot.protocol.game.outgoing.codec.map.RebuildRegionEncoder
-import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityEncoder
+import net.rsprot.protocol.game.outgoing.codec.map.RebuildWorldEntityV2Encoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideLocOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideNpcOpsEncoder
 import net.rsprot.protocol.game.outgoing.codec.misc.client.HideObjOpsEncoder
@@ -221,7 +221,7 @@ public object DesktopGameMessageEncoderRepository {
 
                 bindWithAlts(RebuildNormalEncoder(), RebuildLogin::class.java, RebuildNormal::class.java)
                 bind(RebuildRegionEncoder())
-                bind(RebuildWorldEntityEncoder())
+                bind(RebuildWorldEntityV2Encoder())
 
                 bind(VarpSmallEncoder())
                 bind(VarpLargeEncoder())

protocol/osrs-228/osrs-228-desktop/src/main/kotlin/net/rsprot/protocol/game/outgoing/prot/GameServerProt.kt

@@ -93,7 +93,7 @@ public enum class GameServerProt(
     // Map packets
     REBUILD_NORMAL(GameServerProtId.REBUILD_NORMAL, Prot.VAR_SHORT),
     REBUILD_REGION(GameServerProtId.REBUILD_REGION, Prot.VAR_SHORT),
-    REBUILD_WORLDENTITY(GameServerProtId.REBUILD_WORLDENTITY, Prot.VAR_SHORT),
+    REBUILD_WORLDENTITY_V2(GameServerProtId.REBUILD_WORLDENTITY_V2, Prot.VAR_SHORT),
 
     // Varp packets
     VARP_SMALL(GameServerProtId.VARP_SMALL, 3),