minecraft-data 2.116.0 → 2.118.0

package/doc/history.md

@@ -1,3 +1,12 @@
+## 2.118.0
+* update mcdata
+
+## 2.117.1
+* Add support for custom supportFeature return type
+
+## 2.117.0
+* update mcdata
+
 ## 2.116.0
 * update mcdata
 

package/index.d.ts

@@ -876,6 +876,58 @@ declare namespace MinecraftData {
       entityLoot: any;
   }
   
+  export interface LoginPacket {
+      entityId: number;
+  
+      /**
+       * introduced in Minecraft 1.16.2
+       */
+      isHardcore?: boolean;
+  
+      gameMode: number;
+  
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      previousGameMode?: number;
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      worldNames?: string[];
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      dimensionCodec?: any;
+  
+      dimension: any;
+  
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      worldName?: string;
+  
+      hashedSeed: number;
+      maxPlayers: number;
+      viewDistance: number;
+  
+      /**
+       * Introduced in Minecraft 1.18
+       */
+      simulationDistance?: number;
+  
+      reducedDebugInfo: boolean;
+      enableRespawnScreen: boolean;
+  
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      isDebug?: boolean;    
+      /**
+       * Introduced in Minecraft 1.17
+       */
+      isFlat?: boolean;
+  }
+  
   export interface IndexedData {
       isNewerOrEqualTo(version: string): boolean;
       isOlderThan(version: string): boolean;
@@ -883,6 +935,8 @@ declare namespace MinecraftData {
       blocksByName: { [name: string]: Block; };
       blocksArray: Block[];
   
+      loginPacket: LoginPacket;
+  
       items: { [id: number]: Item; };
       itemsByName: { [name: string]: Item; };
       itemsArray: Item[];

package/index.js

@@ -55,7 +55,8 @@ module.exports = function (mcVersion, preNetty) {
 
   const majorVersion = toMajor(mcVersion, preNetty)
   if (majorVersion == null) { return null }
-  if (cache[majorVersion.type + '_' + majorVersion.majorVersion]) { return cache[majorVersion.type + '_' + majorVersion.majorVersion] }
+  const cachedName = `${majorVersion.type}_${majorVersion.majorVersion}_${majorVersion.dataVersion}`
+  if (cache[cachedName]) { return cache[cachedName] }
   const mcData = data[majorVersion.type][majorVersion.majorVersion]
   if (mcData == null) { return null }
   const nmcData = mcDataToNode(mcData)
@@ -63,8 +64,8 @@ module.exports = function (mcVersion, preNetty) {
   nmcData.isNewerOrEqualTo = version => nmcData.version['>='](version)
   nmcData.isOlderThan = version => nmcData.version['<'](version)
   nmcData.version = Object.assign(majorVersion, nmcData.version)
-  cache[majorVersion.type + '_' + majorVersion.majorVersion] = nmcData
-  nmcData.supportFeature = feature => supportFeature(feature, nmcData.version.minecraftVersion)
+  cache[cachedName] = nmcData
+  nmcData.supportFeature = feature => supportFeature(feature, nmcData.version)
   return nmcData
 }
 

package/lib/supportsFeature.js

@@ -1,31 +1,63 @@
 const features = require('../minecraft-data/data/pc/common/features.json')
-
-const versions = {
-  pc: require('../minecraft-data/data/pc/common/protocolVersions.json'),
-  bedrock: require('../minecraft-data/data/bedrock/common/protocolVersions.json')
-}
-const versionList = versions.pc
-const versionToIndex = Object.fromEntries(versionList.map((version, i) => [version.minecraftVersion, versionList.length - i]))
 const nameToFeature = Object.fromEntries(features.map(feature => [feature.name, feature]))
 
-module.exports = (featureName, minecraftVersion) => {
+function isFeatureInRange (featureName, versionObj) {
   const feature = nameToFeature[featureName]
   if (feature === undefined) {
     throw new Error(`Feature ${feature} doesn't exist`)
   }
 
-  const currentVer = versionToIndex[minecraftVersion]
-  const minVer = versionToIndex[feature.versions[0]]
-  const maxVer = versionToIndex[feature.versions[1]]
-  if (currentVer === undefined) {
-    throw new Error(`Version ${minecraftVersion} doesn't exist`)
+  if (feature.values) {
+    for (const { value, versions, version } of feature.values) { // we're using feature.version
+      if (version) {
+        const ver = version.replace('_major', '')
+        if (!/^\d\.\d+$/.test(ver)) {
+          throw new Error(`Not a correct major version value, instead the version is: "${version}"`)
+        }
+        if (versionObj.majorVersion === ver) {
+          return value
+        }
+      } else { // we're using feature.versions
+        const [minVer, maxVer] = versions
+        if (isVersionInRange(minVer, versionObj, maxVer)) {
+          return value
+        }
+      }
+    }
+    return null // if we didn't match anything, return null
+  } else {
+    const [minVer, maxVer] = feature.versions
+    return isVersionInRange(minVer, versionObj, maxVer)
+  }
+}
+
+function isVersionInRange (minVer, versionObj, maxVer) {
+  let inRange = true
+  const { majorVersion } = versionObj
+  if (minVer.endsWith('_major')) {
+    const ver = removeMajorSuffix(minVer)
+    inRange = inRange && getVersionObj(majorVersion)['>='](ver)
+  } else {
+    inRange = inRange && versionObj['>='](minVer)
   }
-  if (minVer === undefined) {
-    throw new Error(`Version ${feature.versions[0]} doesn't exist`)
+  if (maxVer === 'latest') { // no need to check upper bound if upperbound is latest
+    return inRange
   }
-  if (maxVer === undefined) {
-    throw new Error(`Version ${feature.versions[1]} doesn't exist`)
+  if (maxVer.endsWith('_major')) {
+    const ver = removeMajorSuffix(maxVer)
+    inRange = inRange && getVersionObj(majorVersion)['<='](ver)
+  } else {
+    inRange = inRange && versionObj['<='](maxVer)
   }
+  return inRange
+}
+
+function removeMajorSuffix (verStr) {
+  return verStr.replace('_major', '')
+}
 
-  return minVer <= currentVer && currentVer <= maxVer
+function getVersionObj (ver) {
+  return require('minecraft-data')(ver).version
 }
+
+module.exports = isFeatureInRange

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

@@ -333,5 +333,108 @@
     "name": "sendStringifiedSignText",
     "description": "sign text send when updating signs is send as stringified strings",
     "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "metadataIxOfItem",
+    "description": "item.metadata[this_ix] will be the item that was dropped on the ground",
+    "values": [
+      {
+        "value": 8,
+        "versions": ["1.17_major", "latest"]
+      },
+      {
+        "value": 7,
+        "versions": ["1.14_major", "1.16_major"]
+      },
+      {
+        "value": 6,
+        "versions": ["1.10_major", "1.13_major"]
+      },
+      {
+        "value": 5,
+        "version": "1.9_major"
+      },
+      {
+        "value": 8,
+        "version": "1.8_major"
+      }
+    ]
+  },
+  {
+    "name": "itemSerializationWillOnlyUsePresent",
+    "description": "item serialization in [even] newer versions uses present field [exclusively] to show nullability rather than sending blockId as -1",
+    "versions": ["1.14_major", "latest"]
+  },
+  {
+    "name": "itemSerializationAllowsPresent",
+    "description": "item serialization in newer versions uses present field to show nullability rather or sending blockId as -1 can be used",
+    "versions": ["1.13_major", "latest"]
+  },
+  {
+    "name": "itemSerializationUsesBlockId",
+    "description": "item serialization in older versions uses blockId field to show nullability by setting blockId to -1",
+    "versions": ["1.8_major", "1.12_major"]
+  },
+  {
+    "name": "saveDurabilityAsDamage",
+    "description": "in newer versions, an nbt key called 'Damage' is used to store durability",
+    "versions": ["1.13_major", "latest"]
+  },
+  {
+    "name": "nbtNameForEnchant",
+    "description": "what the nbt key for enchants is",
+    "values": [
+      {
+        "value": "Enchantments",
+        "versions": ["1.13_major", "latest"]
+      },
+      {
+        "value": "ench",
+        "versions": ["1.8_major", "1.12_major"]
+      }
+    ]
+  },
+  {
+    "name": "typeOfValueForEnchantLevel",
+    "description": "type of value that stores enchant lvl in the nbt",
+    "values": [
+      {
+        "value": "string",
+        "versions": ["1.13_major", "latest"]
+      },
+      {
+        "value": "short",
+        "versions": ["1.8_major", "1.12_major"]
+      }
+    ]
+  },
+  {
+    "name": "whereDurabilityIsSerialized",
+    "description": "where the durability is saved in nbt",
+    "values": [
+      {
+        "value": "Damage",
+        "versions": ["1.13_major", "latest"]
+      },
+      {
+        "value": "metadata",
+        "versions": ["1.8_major", "1.12_major"]
+      }
+    ]
+  },
+  {
+    "name": "spawnEggsUseInternalIdInNbt",
+    "description": "in older versions, spawn eggs have a field in their nbt called 'internalId' which tells what entity they will spawn",
+    "versions": ["1.8_major", "1.8_major"]
+  },
+  {
+    "name": "spawnEggsUseEntityTagInNbt",
+    "description": "in older versions, spawn eggs have a key in their nbt called EntityTag which is an object with a field called id, which is an identifier like 'minecraft:cow' that tells the client what mob this egg will spawn",
+    "versions": ["1.9_major", "1.12_major"]
+  },
+  {
+    "name": "spawnEggsHaveSpawnedEntityInName",
+    "description": "in newer versions, spawn eggs have the entity they spawn in their name, ex: 'squid_spawn_egg'",
+    "versions": ["1.13_major", "latest"]
   }
 ]

package/minecraft-data/doc/history.md

@@ -1,3 +1,9 @@
+## 2.118.0
+* Add prismarine-item features
+
+## 2.117.0
+* Add "metadataIxOfItem" feature
+
 ## 2.116.0
 * Fix loginPacket for 1.18.2
 

package/minecraft-data/schemas/features_schema.json

@@ -19,7 +19,6 @@
       "versions": {
         "description": "A tuple that describes the range of versions in the range",
         "type": "array",
-        "uniqueItems": true,
         "items": {
           "title": "versionForFeatureIdentification",
           "type": "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minecraft-data",
-  "version": "2.116.0",
+  "version": "2.118.0",
   "description": "Provide easy access to minecraft data in node.js",
   "main": "index.js",
   "tonicExampleFilename": "example.js",

package/test/load.js

@@ -44,3 +44,32 @@ describe('versions with block data have block state IDs', () => {
     assert(oks > 0)
   })
 })
+
+describe('supportFeature', () => {
+  it('dimensionIsAnInt is only accessible in 1.8 - 1.15.2', () => {
+    const mcData1Dot9 = require('minecraft-data')('1.9')
+    const mcData1Dot17 = require('minecraft-data')('1.17')
+    assert.equal(mcData1Dot9.supportFeature('dimensionIsAnInt'), true)
+    assert.equal(mcData1Dot17.supportFeature('dimensionIsAnInt'), false)
+  })
+
+  it('metadataIxOfItem works right', () => {
+    const assertions = {
+      1.18: 8,
+      1.17: 8,
+      '1.16.1': 7,
+      1.16: 7,
+      1.15: 7,
+      '1.13.2': 6,
+      '1.10': 6,
+      '1.9.1': 5,
+      1.9: 5,
+      1.8: 8
+    }
+    for (const [k, v] of Object.entries(assertions)) {
+      const mcData = require('minecraft-data')(k)
+      const newVal = mcData.supportFeature('metadataIxOfItem')
+      assert.equal(newVal, v, `Failed on mc version ${k} | Expected: ${v}, Got: ${newVal}`)
+    }
+  })
+})

package/typings/index-template.d.ts

@@ -41,6 +41,58 @@ export interface Schemas {
     entityLoot: any;
 }
 
+export interface LoginPacket {
+    entityId: number;
+
+    /**
+     * introduced in Minecraft 1.16.2
+     */
+    isHardcore?: boolean;
+
+    gameMode: number;
+
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    previousGameMode?: number;
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    worldNames?: string[];
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    dimensionCodec?: any;
+
+    dimension: any;
+
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    worldName?: string;
+
+    hashedSeed: number;
+    maxPlayers: number;
+    viewDistance: number;
+
+    /**
+     * Introduced in Minecraft 1.18
+     */
+    simulationDistance?: number;
+
+    reducedDebugInfo: boolean;
+    enableRespawnScreen: boolean;
+
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    isDebug?: boolean;    
+    /**
+     * Introduced in Minecraft 1.17
+     */
+    isFlat?: boolean;
+}
+
 export interface IndexedData {
     isNewerOrEqualTo(version: string): boolean;
     isOlderThan(version: string): boolean;
@@ -48,6 +100,8 @@ export interface IndexedData {
     blocksByName: { [name: string]: Block; };
     blocksArray: Block[];
 
+    loginPacket: LoginPacket;
+
     items: { [id: number]: Item; };
     itemsByName: { [name: string]: Item; };
     itemsArray: Item[];