Add Willox's updates - part 1, World

Author: 20kdc

.gitignore

@@ -18,6 +18,7 @@ after/external/test-subjects
 research-projects/*.dmb
 research-projects/*.lk
 research-projects/*.int
+research-projects/*.rsc
 # clutters the repo
 research-projects/*.sav
 # not sure what to do with these, and it's not like they're hard to get

README.md

@@ -27,6 +27,8 @@ Tomeno: important parts of string decryption and protocol decryption
 BobOfDoom, NGGJamie, Crispy: Documented the BYOND Topic protocol at https://github.com/NGGJamie/byond-topics
 This was useful to understand BYOND packet framing, not covering encryption
 
+Willox: Documented some of the previously unknown properties at https://github.com/willox/dmasm/blob/dmb/src/dmb/loader.rs
+
 Stephen001: Partial documentation of some format version (right now unknown but >= 307 < 494) at https://github.com/Stephen001/Lego
 
 The Red Book (Super Saiyan X, LordAndrew, Kaiochao, DarkCampainger et al.): Informed me of the existence of modified types.

after-tools/settings.gradle

@@ -1,5 +1,6 @@
 package after.io;
 
+import after.annotations.CacheFileID;
 import after.annotations.ClassID;
 import after.annotations.ListOfProcID;
 import after.annotations.MobTypeID;
@@ -9,6 +10,8 @@
 import after.io.framework.DMBWriteContext;
 import static after.io.DMBObjectEntryBasedSubblock.OBJ_NULL;
 
+import aedium.ElementMarkers;
+
 public class DMBStandardObjectIDs {
 	@MobTypeID // Nullable
 	public int mob = OBJ_NULL;
@@ -21,7 +24,8 @@ public class DMBStandardObjectIDs {
 	public int procs = OBJ_NULL;
 	@ProcID // Nullable
 	public int globalVariableInitializer = OBJ_NULL;
-	public int idBAC = OBJ_NULL;
+	@StringID // Nullable
+	public int domain = OBJ_NULL;
 	@StringID
 	public int name = OBJ_NULL;
 	// GEN < 368 (yes, under)
@@ -34,17 +38,19 @@ public class DMBStandardObjectIDs {
 	@ClassID
 	public int image = OBJ_NULL;
 	// --	
-	public byte unkB;
-	public byte unkC = 1;
+	public byte clientLazyEye;
+	public byte clientDir = 1;
 	// GEN >= 415
-	public short unkD;
+	public short clientControlFreak;
 	// --
 	public byte unkE;
 	// GEN >= 230
-	public int idC = OBJ_NULL;
+	@StringID // Nullable
+	public int clientScript = OBJ_NULL;
 	// --
 	// GEN >= 507
-	public int[] idEvenMore = new int[0];
+	@ElementMarkers(CacheFileID.class)
+	public int[] clientScriptFiles = new int[0];
 	// GEN < 507 (yes, under)
 	public int idX = OBJ_NULL;
 	// GEN >= 232
@@ -59,48 +65,53 @@ public class DMBStandardObjectIDs {
 	// GEN >= 266
 	@StringID // Nullable
 	public int serverName = OBJ_NULL;
-	public int[] unkBG = new int[2];
+	public int hubNumber;
+	public int gameVersion;
 	// GEN >= 272
-	public short unkG = 30;
-	public int[] idAY = new int[] {OBJ_NULL, OBJ_NULL};
+	public short cacheLifespan = 30;
+	@StringID // Nullable
+	public int clientCommandText;
+	@StringID // Nullable
+	public int clientCommandPrompt;
 	// GEN >= 276
 	@StringID // Nullable
 	public int hub = OBJ_NULL;
 	// GEN >= 305
 	@StringID // Nullable (?) but really should be "default"
 	public int channel = OBJ_NULL;
 	// GEN >= 360
-	public int idAZB = OBJ_NULL;
+	@CacheFileID // Nullable
+	public int skin = OBJ_NULL;
 
 	// LHS >= 455
 	public short iconSizeX = 32;
 	public short iconSizeY = 32;
-	public short unkZ = (short) 32768;
+	public short mapFormat = (short) 32768;
 
 	public void read(DMBReadContext rc) {
 		mob = rc.id();
 		turf = rc.id();
 		area = rc.id();
 		procs = rc.id();
 		globalVariableInitializer = rc.id();
-		idBAC = rc.id();
+		domain = rc.id();
 		name = rc.id();
 		if (rc.vGEN < 368)
 			idOld1 = rc.id();
 		tickTimeMillis = rc.io.getInt();
 		client = rc.id();
 		if (rc.vGEN >= 308)
 			image = rc.id();
-		unkB = rc.io.get();
-		unkC = rc.io.get();
+		clientLazyEye = rc.io.get();
+		clientDir = rc.io.get();
 		if (rc.vGEN >= 415)
-			unkD = rc.io.getShort();
+			clientControlFreak = rc.io.getShort();
 		unkE = rc.io.get();
 		if (rc.vGEN >= 230)
-			idC = rc.id();
+			clientScript = rc.id();
 		if (rc.vGEN >= 507) {
-			idEvenMore = new int[rc.io.getShort() & 0xFFFF];
-			rc.ids(idEvenMore);
+			clientScriptFiles = new int[rc.io.getShort() & 0xFFFF];
+			rc.ids(clientScriptFiles);
 		}
 		if (rc.vGEN < 507) {
 			idX = rc.id();
@@ -115,27 +126,29 @@ public void read(DMBReadContext rc) {
 			hubPasswordHashed = rc.id();
 		if (rc.vGEN >= 266) {
 			serverName = rc.id();
-			rc.ints(unkBG);
+			hubNumber = rc.io.getInt();
+			gameVersion = rc.io.getInt();
 		}
 		if (rc.vGEN >= 272) {
-			unkG = rc.io.getShort();
-			rc.ids(idAY);
+			cacheLifespan = rc.io.getShort();
+			clientCommandText = rc.id();
+			clientCommandPrompt = rc.id();
 		}
 		if (rc.vGEN >= 276)
 			hub = rc.id();
 		if (rc.vGEN >= 305)
 			channel = rc.id();
 		if (rc.vGEN >= 360)
-			idAZB = rc.id();
+			skin = rc.id();
 
 		if (rc.vLHS >= 455) {
 			iconSizeX = rc.io.getShort();
 			iconSizeY = rc.io.getShort();
-			unkZ = rc.io.getShort();
+			mapFormat = rc.io.getShort();
 		} else {
 			iconSizeX = 32;
 			iconSizeY = 32;
-			unkZ = (short) 32768;
+			mapFormat = (short) 32768;
 		}
 	}
 
@@ -145,24 +158,24 @@ public void write(DMBWriteContext wc) {
 		wc.id(area);
 		wc.id(procs);
 		wc.id(globalVariableInitializer);
-		wc.id(idBAC);
+		wc.id(domain);
 		wc.id(name);
 		if (wc.vGEN < 368)
 			wc.id(idOld1);
 		wc.i32(tickTimeMillis);
 		wc.id(client);
 		if (wc.vGEN >= 308)
 			wc.id(image);
-		wc.i8(unkB);
-		wc.i8(unkC);
+		wc.i8(clientLazyEye);
+		wc.i8(clientDir);
 		if (wc.vGEN >= 415)
-			wc.i16(unkD);
+			wc.i16(clientControlFreak);
 		wc.i8(unkE);
 		if (wc.vGEN >= 230)
-			wc.id(idC);
+			wc.id(clientScript);
 		if (wc.vGEN >= 507) {
-			wc.i16(idEvenMore.length);
-			wc.ids(idEvenMore);
+			wc.i16(clientScriptFiles.length);
+			wc.ids(clientScriptFiles);
 		}
 		if (wc.vGEN < 507)
 			wc.id(idX);
@@ -176,22 +189,24 @@ public void write(DMBWriteContext wc) {
 			wc.id(hubPasswordHashed);
 		if (wc.vGEN >= 266) {
 			wc.id(serverName);
-			wc.ints(unkBG);
+			wc.i32(hubNumber);
+			wc.i32(gameVersion);
 		}
 		if (wc.vGEN >= 266) {
-			wc.i16(unkG);
-			wc.ids(idAY);
+			wc.i16(cacheLifespan);
+			wc.id(clientCommandText);
+			wc.id(clientCommandPrompt);
 		}
 		if (wc.vGEN >= 276)
 			wc.id(hub);
 		if (wc.vGEN >= 305)
 			wc.id(channel);
 		if (wc.vGEN >= 360)
-			wc.id(idAZB);
+			wc.id(skin);
 		if (wc.vLHS >= 455) {
 			wc.i16(iconSizeX);
 			wc.i16(iconSizeY);
-			wc.i16(unkZ);
+			wc.i16(mapFormat);
 		}
 	}
 }

after/src/main/java/after/io/DMBStandardObjectIDs.java

@@ -1,5 +1,9 @@
 # INCOMPLETE BUT STRUCTURALLY COMPLETE UP TO V512
 
+Addendum to this disclaimer - I haven't yet found indications of anything going particularly *wrong* when using this information on V514.
+
+But that may simply be due to a lack of feature use (i.e. RHS version differences).
+
 ## Taxonomy
 
 An "ObjectID" is a generic object ID which there isn't details for yet.
@@ -405,7 +409,7 @@ It is reasonable to assume that null instances are used to pad out long empty re
 3. Nullable ClassID area
 4. Nullable ListID of ProcID procs (this contains procs attached to /world)
 5. Nullable ProcID globalVariableInitializer (this contains global variable initializers)
-6. Nullable ObjectID unk
+6. Nullable StringID domain (this is `world.domain`, a mysterious, seemingly undocumented property - thanks to Willox for finding this)
 7. StringID name
 
 If GEN Version < 368 (YES, UNDER) {
@@ -414,7 +418,7 @@ If GEN Version < 368 (YES, UNDER) {
 
 }
 
-1. Uint32 tickTimeMillis (This is related to server tick time and is likely in milliseconds. Seems to default to 100.)
+1. Uint32 tickTimeMillis (this is `world.tick_lag`, multiplied by 100 - essentially, the time per tick measured in integer milliseconds.)
 2. ClassID client
 
 If GEN Version >= 308 {
@@ -423,27 +427,27 @@ If GEN Version >= 308 {
 
 }
 
-1. Uint8 unk
-2. Uint8 unk (Seems to default to 1, but isn't necessary)
+1. Uint8 clientLazyEye (this is `client.lazy_eye`, used for camera control - thanks to Willox for finding this)
+2. Uint8 clientDir (this is `client.dir` - defaults to 1 (NORTH). - thanks to Willox for finding this)
 
 If GEN Version >= 415 {
 
-1. Uint16 unk
+1. Uint16 clientControlFreak (this is `client.control_freak`, used to restrict skins and macros - thanks to Willox for finding this)
 
 }
 
 1. Uint8 unk (again)
 
 If GEN Version >= 230 {
 
-1. ObjectID unk
+1. Nullable StringID clientScript (this is `client.script` *specifically* as a string - thanks to Willox for finding this)
 
 }
 
 If GEN Version >= 507 {
 
-1. Uint16 evenMoreCount
-2. Array of evenMoreCount ObjectIDs evenMore
+1. Uint16 clientScriptCacheFileCount
+2. Array of clientScriptCacheFileCount CacheFileIDs clientScriptCacheFiles (this is every `client.script` file - thanks to Willox for finding this)
 
 }
 
@@ -480,20 +484,22 @@ If GEN Version >= 341 {
 If GEN Version >= 266 {
 
 1. Nullable StringID serverName
-2. Array of 2 Uint32s unk
+2. Uint32 hubNumber (This is where `world.hub` goes when a number is provided - thanks to Willox for finding this)
+3. Uint32 gameVersion (`world.version`, not to be confused with the BYOND version - thanks to Willox for finding this)
 
 }
 
 If GEN Version >= 272 {
 
-1. Uint16 unk (best set to 30)
-2. Array of 2 Nullable ObjectIDs unk
+1. Uint16 cacheLifespan (Best set to 30. `world.cache_lifespan`, in days - thanks to Willox for finding this)
+2. Nullable StringID clientCommandText (`client.command_text` - thanks to Willox for finding this)
+3. Nullable StringID clientCommandPrompt (`client.command_prompt` (undocumented?) - thanks to Willox for finding this)
 
 }
 
 If GEN Version >= 276 {
 
-1. Nullable StringID hub (this is the `user.game` hub name)
+1. Nullable StringID hub (this is the `user.game` hub name, i.e. `world.hub`)
 
 }
 
@@ -505,15 +511,15 @@ If GEN Version >= 305 {
 
 If GEN Version >= 360 {
 
-1. ObjectID unk
+1. Nullable CacheFileID skin (DMI and friends - thanks to Willox for finding this)
 
 }
 
 If LHS Version >= 455 {
 
 1. Uint16 iconSizeX (default 32)
 2. Uint16 iconSizeY (default 32)
-3. Uint16 unk (default 32768)
+3. Uint16 mapFormat (default 32768 - thanks to Willox for finding this)
 
 }
 

formats/DMB.md

@@ -1,7 +1,8 @@
 OBJECTS = \
  proc-inherit-quirks-1.dmb proc-inherit-quirks-2.dmb proc-inherit-quirks-3.dmb \
  rand-inherit.dmb turf-atom-equivalence.dmb savefile.dmb world-channel.dmb \
- modified-types.dmb a-very-long-output.dmb mapsurgery-game.dmb mapsurgery-map.dmb
+ modified-types.dmb a-very-long-output.dmb mapsurgery-game.dmb mapsurgery-map.dmb \
+ world-oddprops.dmb
 
 all: $(OBJECTS)
 .PHONY: clean

research-projects/Makefile

@@ -0,0 +1,3 @@
+// nope
+<A/>
+

research-projects/a.dms

@@ -0,0 +1,3 @@
+// nope
+<B/>
+

research-projects/b.dms

@@ -0,0 +1,14 @@
+// World odd properties
+
+/world
+	domain = "this is an example of string" // Thanks to Willox
+	tick_lag = 0.5
+	hub = 1337
+
+/client
+	script = 'a.dms'
+	script = 'b.dms'
+	script = "<C/>"
+	command_text = "Outstandingly pokable."
+	command_prompt = "Outstandingly undocumented."
+