minecraft-data 3.35.0 → 3.36.0

package/minecraft-data/data/pc/1.19.4/protocol.json

@@ -374,19 +374,19 @@
       {
         "compareTo": "$compareTo",
         "fields": {
-          "0": "i8",
-          "1": "varint",
-          "2": "varlong",
-          "3": "f32",
-          "4": "string",
-          "5": "string",
-          "6": [
+          "byte": "i8",
+          "int": "varint",
+          "long": "varlong",
+          "float": "f32",
+          "string": "string",
+          "component": "string",
+          "optional_component": [
             "option",
             "string"
           ],
-          "7": "slot",
-          "8": "bool",
-          "9": [
+          "item_stack": "slot",
+          "boolean": "bool",
+          "rotations": [
             "container",
             [
               {
@@ -403,21 +403,21 @@
               }
             ]
           ],
-          "10": "position",
-          "11": [
+          "block_pos": "position",
+          "optional_block_pos": [
             "option",
             "position"
           ],
-          "12": "varint",
-          "13": [
+          "direction": "varint",
+          "optional_uuid": [
             "option",
             "UUID"
           ],
-          "14": "varint",
-          "15": "optvarint",
-          "16": "nbt",
-          "17": "particle",
-          "18": [
+          "block_state": "varint",
+          "optional_block_state": "optvarint",
+          "compound_tag": "nbt",
+          "particle": "particle",
+          "villager_data": [
             "container",
             [
               {
@@ -434,18 +434,18 @@
               }
             ]
           ],
-          "19": "optvarint",
-          "20": "varint",
-          "21": "varint",
-          "22": "varint",
-          "23": [
+          "optional_unsigned_int": "optvarint",
+          "pose": "varint",
+          "cat_variant": "varint",
+          "frog_variant": "varint",
+          "optional_global_pos": [
             "option",
             "string"
           ],
-          "24": "varint",
-          "25": "varint",
-          "26": "vec3f",
-          "27": "vec4f"
+          "painting_variant": "varint",
+          "sniffer_state": "varint",
+          "vector3": "vec3f",
+          "quaternion": "vec4f"
         }
       }
     ],
@@ -457,19 +457,46 @@
           "container",
           [
             {
-              "anon": true,
+              "name": "key",
+              "type": "u8"
+            },
+            {
+              "name": "type",
               "type": [
-                "container",
-                [
-                  {
-                    "name": "key",
-                    "type": "u8"
-                  },
-                  {
-                    "name": "type",
-                    "type": "varint"
+                "mapper",
+                {
+                  "type": "varint",
+                  "mappings": {
+                    "0": "byte",
+                    "1": "int",
+                    "2": "long",
+                    "3": "float",
+                    "4": "string",
+                    "5": "component",
+                    "6": "optional_component",
+                    "7": "item_stack",
+                    "8": "boolean",
+                    "9": "rotations",
+                    "10": "block_pos",
+                    "11": "optional_block_pos",
+                    "12": "direction",
+                    "13": "optional_uuid",
+                    "14": "block_state",
+                    "15": "optional_block_state",
+                    "16": "compound_tag",
+                    "17": "particle",
+                    "18": "villager_data",
+                    "19": "optional_unsigned_int",
+                    "20": "pose",
+                    "21": "cat_variant",
+                    "22": "frog_variant",
+                    "23": "optional_global_pos",
+                    "24": "painting_variant",
+                    "25": "sniffer_state",
+                    "26": "vector3",
+                    "27": "quaternion"
                   }
-                ]
+                }
               ]
             },
             {
@@ -6731,4 +6758,4 @@
       }
     }
   }
-}
+}

package/minecraft-data/data/pc/common/features.json

@@ -721,5 +721,10 @@
     "name": "hasBundlePacket",
     "description": "Has a Bundle Packet to group packets for processing at once",
     "versions": ["1.19.4", "latest"]
+  },
+  {
+    "name": "mcDataHasEntityMetadata",
+    "description": "Entity Metadata is defined in mcdata",
+    "versions": ["1.19.4", "latest"]
   }
 ]

package/minecraft-data/doc/history.md

@@ -1,3 +1,6 @@
+## 3.36.0
+* pc: add entity metadata (@extremeheat)
+
 ## 3.35.0
 * Add bedrock 1.20.0 protocol data
 

package/minecraft-data/schemas/entities_schema.json

@@ -60,6 +60,13 @@
       "category": {
         "description": "The category of an entity : a semantic category",
         "type": "string"
+      },
+      "metadataKeys": {
+        "description": "The pc metadata tags of an entity. (Naming is via mc code, with data_ and id_ prefixes stripped)",
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
       }
     },
     "required": [

package/minecraft-data/tools/js/extractPcEntityMetadata.js

@@ -0,0 +1,153 @@
+const fs = require('fs')
+const cp = require('child_process')
+const { globSync } = require('glob')
+const version = process.argv[2] || '1.19.4'
+if (!version) {
+  console.log('Usage: node extractEntityMetadata.js <version>')
+  process.exit(1)
+}
+
+if (!fs.existsSync(version)) {
+  cp.execSync(`git clone -b client${version} https://github.com/extremeheat/extracted_minecraft_data.git ${version} --depth 1`, { stdio: 'inherit' })
+}
+
+function getEntityTypes () {
+  const entityTypes = fs.readFileSync(`./${version}/client/net/minecraft/world/entity/EntityType.java`, 'utf8')
+  const entityTypesLines = entityTypes.split(';')
+  const classNameTo = {}
+  for (const line of entityTypesLines) {
+    if (line.includes('= register(')) {
+      // Given the line: public static final EntityType<Allay> ALLAY = register( "allay", EntityType.Builder.<Allay>of(Allay::new, MobCategory.CREATURE).sized(0.35F, 0.6F).clientTrackingRange(8).updateInterval(2) );
+      // we extract Allay and "allay"
+      const regex = line.match(/EntityType<(.*)> (.*) = register\(\W+"([a-z0-9_]+)"/)
+      if (regex) {
+        const [, type, , name] = regex
+        classNameTo[type] = name
+      }
+    }
+  }
+  return classNameTo
+}
+
+function getEntityMetadataSerializers () {
+  const output = []
+  const entityTypes = fs.readFileSync(`./${version}/client/net/minecraft/network/syncher/EntityDataSerializers.java`, 'utf8')
+  const entityTypesLines = entityTypes.split(';')
+  for (const line of entityTypesLines) {
+    if (line.includes('registerSerializer')) {
+      // From:       registerSerializer(BYTE);
+      // We extract: BYTE
+      const regex = line.match(/ {2}registerSerializer\((.*)\)/)
+      if (regex) {
+        const [, type] = regex
+        output.push(type)
+      }
+    }
+  }
+  return output.map(e => e.toLowerCase())
+}
+
+const serializers = getEntityMetadataSerializers()
+const classNameToRegistryName = getEntityTypes()
+
+const allEntityFiles = globSync(`${version}/**/entity/**/*.java`)
+const allEntityFileCodes = Object.fromEntries(allEntityFiles.map(file => [
+  file.split(/\\|\//g).pop().replace('.java', ''),
+  fs.readFileSync(file, 'utf8')
+]))
+
+const entityPreTree = []
+const metadatas = {}
+
+for (const file in allEntityFileCodes) {
+  const code = allEntityFileCodes[file]
+  const lines = code.split(';')
+  let lastClass
+  for (const line of lines) {
+    let lineWithoutGenerics = line.replace(/<.*>/g, '')
+    const bloatMods = ['abstract', 'static']
+    for (const mod of bloatMods) lineWithoutGenerics = lineWithoutGenerics.replace(` ${mod} `, ' ')
+
+    if (lineWithoutGenerics.includes('public class ')) {
+      const className = lineWithoutGenerics.split('public class ')[1]?.split(' ')[0]
+      lastClass = className
+      const extend = lineWithoutGenerics.split('extends ')[1]?.split(' ')[0]
+      if (className === file) {
+        if (extend) entityPreTree.push([extend, file])
+        else entityPreTree.push([file])
+      } else if (extend === file) {
+        lastClass = `${file}.${className}`
+        entityPreTree.push([file, lastClass])
+      }
+    }
+
+    if (line.includes('SynchedEntityData.defineId(')) {
+      // from:    private static final EntityDataAccessor<Sniffer.State> DATA_STATE = SynchedEntityData.defineId(Sniffer.class, EntityDataSerializers.SNIFFER_STATE);
+      // extract: DATA_STATE, SNIFFER_STATE
+      const r = line.match(/> ([A-Z_0-9]+) = .*EntityDataSerializers.([A-Z_0-9]+)/s)
+      if (r) {
+        const [, data, serializer] = r
+        ; (metadatas[lastClass] ??= []).push([data, serializer])
+      } else {
+        throw new Error('Failed to parse line: ' + line)
+      }
+    }
+  }
+}
+
+const tree = {}
+const flat = {}
+const handledNames = []
+function build (ele, root = tree, arr = []) {
+  const name = classNameToRegistryName[ele]
+  const metadata = metadatas[ele]
+  root[ele] = { children: {}, name, metadata }
+  if (name) flat[name] = arr.concat(metadata ?? [])
+  handledNames.push(ele)
+  for (const [key, val] of entityPreTree) {
+    if (key === ele) {
+      build(val, root[key].children, arr.concat(metadata ?? []))
+    }
+  }
+}
+build('Entity')
+
+for (const key in classNameToRegistryName) {
+  if (!handledNames.includes(key)) throw new Error('Unhandled entity ' + key)
+}
+
+function updateMcDataEntitiesJSON () {
+  const presentMcDataPath = `../../data/pc/${version}/entities.json`
+  const presentMcData = require(presentMcDataPath)
+  for (const entry of presentMcData) {
+    entry.metadataKeys = flat[entry.name].map(e => e[0].replace('DATA_', '').replace('_ID', '').replace('ID_', '').toLowerCase())
+  }
+  fs.writeFileSync(presentMcDataPath, JSON.stringify(presentMcData, null, 2))
+}
+
+function updateMcDataProtocolJSON () {
+  const presentMcDataPath = `../../data/pc/${version}/protocol.json`
+  const mcdata = require(presentMcDataPath)
+  const mapper = { type: 'varint', mappings: {} }
+  for (let i = 0; i < serializers.length; i++) {
+    mapper.mappings[i] = serializers[i].toLowerCase()
+  }
+  mcdata.types.entityMetadata[1].type[1] = [
+    { name: 'key', type: 'u8' },
+    { name: 'type', type: ['mapper', mapper] },
+    { name: 'value', type: ['entityMetadataItem', { compareTo: 'type' }] }
+  ]
+  // One time code to remap integers to strings in protocol.json for the entityMetadataItem type
+  // const metadataItems = mcdata.types.entityMetadataItem[1].fields
+  // const next = {}
+  // for (const key in metadataItems) {
+  //   next[serializers[key]] = metadataItems[key]
+  // }
+  // mcdata.types.entityMetadataItem[1].fields = next
+  fs.writeFileSync(presentMcDataPath, JSON.stringify(mcdata, null, 2))
+}
+
+// fs.writeFileSync(`./entityTree.json`, JSON.stringify(tree, null, 2))
+// fs.writeFileSync(`./entityFlat.json`, JSON.stringify(flat, null, 2))
+updateMcDataEntitiesJSON()
+updateMcDataProtocolJSON()

package/minecraft-data/tools/js/package.json

@@ -13,7 +13,8 @@
   },
   "dependencies": {
     "ajv": "^6.5.4",
-    "mocha": "5.2.0",
+    "glob": "^10.2.6",
+    "mocha": "^10.2.0",
     "protodef-validator": "^1.2.2",
     "protodef-yaml": "^1.2.2",
     "standard": "^16.0.3"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minecraft-data",
-  "version": "3.35.0",
+  "version": "3.36.0",
   "description": "Provide easy access to minecraft data in node.js",
   "main": "index.js",
   "tonicExampleFilename": "example.js",
@@ -8,9 +8,9 @@
     "generate:types": "node typings/generate-typings.js",
     "generate:data": "node ./bin/generate_data.js",
     "test:types": "tsc typings/test-typings && node typings/test-typings.js",
-    "test": "require-self && npm run generate:types && npm run generate:data && npm run lint && npm run test:types && mocha",
+    "test": "npm run generate:types && npm run generate:data && npm run lint && npm run test:types && mocha",
     "lint": "standard",
-    "prepare": "require-self && npm run generate:data && npm run generate:types",
+    "prepare": "npm run generate:data && npm run generate:types",
     "fix": "standard --fix"
   },
   "standard": {
@@ -33,11 +33,11 @@
     "url": "https://github.com/PrismarineJS/node-minecraft-data/issues"
   },
   "devDependencies": {
+    "minecraft-data": ".",
     "@types/node": "^20.2.1",
     "json-schema-to-typescript": "11.0.5",
     "minecraft-packets": "^1.4.0",
     "mocha": "^10.0.0",
-    "require-self": "^0.2.3",
     "standard": "^17.0.0",
     "typescript": "~5.0.4"
   },