minecraft-data 2.114.0 → 2.115.2

package/.github/workflows/ci.yml

@@ -25,3 +25,8 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm install
     - run: npm test
+    - name: Upload index.d.ts
+      if: always()
+      uses: actions/upload-artifact@v3.0.0
+      with:
+        path: index.d.ts

package/data.js

@@ -1097,7 +1097,7 @@ module.exports =
       get entities () { return require("./minecraft-data/data/pc/1.18/entities.json") },
       get protocol () { return require("./minecraft-data/data/pc/1.18.2/protocol.json") },
       get windows () { return require("./minecraft-data/data/pc/1.16.1/windows.json") },
-      get version () { return require("./minecraft-data/data/pc/1.18.1/version.json") },
+      get version () { return require("./minecraft-data/data/pc/1.18.2/version.json") },
       get foods () { return require("./minecraft-data/data/pc/1.17/foods.json") },
       get particles () { return require("./minecraft-data/data/pc/1.18/particles.json") },
       get blockLoot () { return require("./minecraft-data/data/pc/1.18/blockLoot.json") },

package/doc/api.md

@@ -337,6 +337,10 @@ Mapping from 1.12 block:metadata to 1.13 block names
 
 examples 0:0 -> minecraft:air
 
+### minecraft-data.supportFeature(featureName) : Boolean
+
+This can be used to check is a specific feature is available in the current Minecraft version. This is usually only required for handling version-specific functionality.
+
 ## Schemas
 
 ### minecraft-data.schemas.biomes

package/doc/history.md

@@ -1,3 +1,12 @@
+## 2.115.2
+* Add supportFeature support
+
+## 2.115.1
+* update mcdata
+
+## 2.114.1
+* update mcdata
+
 ## 2.114.0
 * update mcdata
 

package/index.d.ts

@@ -443,6 +443,26 @@ declare namespace MinecraftData {
   }
   
   
+  type VersionForFeatureIdentification = string;
+  type Features = FeatureEntry[];
+  
+  interface FeatureEntry {
+    /**
+     * The name of the feature
+     */
+    name?: string;
+    /**
+     * The description of the feature
+     */
+    description?: string;
+    /**
+     * A tuple that describes the range of versions in the range
+     */
+    versions?: VersionForFeatureIdentification[];
+    [k: string]: unknown;
+  }
+  
+  
   type Foods = Food[];
   
   interface Food {

package/index.js

@@ -1,4 +1,5 @@
 const mcDataToNode = require('./lib/loader')
+const supportFeature = require('./lib/supportsFeature')
 const indexer = require('./lib/indexer.js')
 const protocolVersions = {
   pc: require('./minecraft-data/data/pc/common/protocolVersions.json'),
@@ -63,7 +64,7 @@ module.exports = function (mcVersion, preNetty) {
   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)
   return nmcData
 }
 

package/lib/supportsFeature.js

@@ -0,0 +1,31 @@
+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) => {
+  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 (minVer === undefined) {
+    throw new Error(`Version ${feature.versions[0]} doesn't exist`)
+  }
+  if (maxVer === undefined) {
+    throw new Error(`Version ${feature.versions[1]} doesn't exist`)
+  }
+
+  return minVer <= currentVer && currentVer <= maxVer
+}

package/minecraft-data/.github/ISSUE_TEMPLATE/blank_issue.md

@@ -0,0 +1,4 @@
+---
+name: Blank Issue
+about: Open a new issue
+---

package/minecraft-data/.github/ISSUE_TEMPLATE/new_version.md

@@ -0,0 +1,14 @@
+---
+name: New Version
+about: Add a new minecraft version to MCD
+title: 'Add version: '
+---
+
+- [ ] Version folder containing "version.json" created
+- [ ] "version.json" filled out appropriately
+- [ ] Added version to dataPath.json
+- [ ] "version" field of dataPath.json points to new version folder
+- [ ] Version added to common/versions.json
+- [ ] Version added to ReadMe
+
+Additional Requirements For This Update:

package/minecraft-data/README.md

@@ -55,6 +55,7 @@ Data provided:
 | Commands | a tree structure for vanilla minecraft server commands, and some info needed to implement sub-parsers.
 | Legacy | mappings between legacy (1.12) and post-flattening (1.13+) blocks and items ids
 | Skin data | (bedrock edition) Skin geometry and texture data for steve skin
+| Features | This can be used to check is a specific feature is available in the current Minecraft version. This is usually only required for handling version-specific functionality.
 
 See more information about this data in the [documentation](http://prismarinejs.github.io/minecraft-data/)
 

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

@@ -0,0 +1 @@
+[]

package/minecraft-data/data/dataPaths.json

@@ -1096,7 +1096,7 @@
       "entities": "pc/1.18",
       "protocol": "pc/1.18.2",
       "windows": "pc/1.16.1",
-      "version": "pc/1.18.1",
+      "version": "pc/1.18.2",
       "foods": "pc/1.17",
       "particles": "pc/1.18",
       "blockLoot": "pc/1.18",

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

@@ -0,0 +1,337 @@
+[
+  {
+    "name": "mobSpawner",
+    "description": "spawner is called mob_spawner",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "spawner",
+    "description": "spawner is called spawner",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "blockMetadata",
+    "description": "block metadata is encoded in a separate metadata",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "blockStateId",
+    "description": "block metadata is encoded as state id",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "creativeSleepNearMobs",
+    "description": "can sleep near mobs in creative",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "fixedPointPosition",
+    "description": "Entity positions are represented with fixed point numbers",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "doublePosition",
+    "description": "Entity positions are represented with double",
+    "versions": ["1.9", "1.18.2"]
+  },
+  {
+    "name": "fixedPointDelta",
+    "description": "Delta of position are represented with fixed point numbers",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "fixedPointDelta128",
+    "description": "Delta of position are represented with fixed point numbers times 128",
+    "versions": ["1.9", "1.18.2"]
+  },
+  {
+    "name": "customChannelMCPrefixed",
+    "description": "custom channel are prefixed by MC|",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "customChannelIdentifier",
+    "description": "custom channel is an identifier starting in minecraft namespace",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "dimensionDataIsAvailable",
+    "description": "dimensionData is available, providing an additional information about the current dimension",
+    "versions": ["1.17", "1.18.2"]
+  },
+  {
+    "name": "useItemWithBlockPlace",
+    "description": "use item is done with block place packet",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "useItemWithOwnPacket",
+    "description": "use item is done with its own packet",
+    "versions": ["1.9", "1.18.2"]
+  },
+  {
+    "name": "blockPlaceHasHeldItem",
+    "description": "block_place packet has heldItem",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "blockPlaceHasHandAndIntCursor",
+    "description": "block_place packet has hand and int cursor",
+    "versions": ["1.9", "1.10.2"]
+  },
+  {
+    "name": "blockPlaceHasHandAndFloatCursor",
+    "description": "block_place packet has hand and float cursor",
+    "versions": ["1.11", "1.13.2"]
+  },
+  {
+    "name": "blockPlaceHasInsideBlock",
+    "description": "block_place packet has inside block",
+    "versions": ["1.14", "1.18.2"]
+  },
+  {
+    "name": "teleportUsesPositionPacket",
+    "description": "teleport is done using position packet",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "positionUpdateSentEveryTick",
+    "description": "the position is sent every tick",
+    "versions": ["1.8", "1.11.2"]
+  },
+  {
+    "name": "teleportUsesOwnPacket",
+    "description": "teleport is done using its own packet",
+    "versions": ["1.9", "1.18.2"]
+  },
+  {
+    "name": "oneBlockForSeveralVariations",
+    "description": "one block of several variations",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "blockSchemeIsFlat",
+    "description": "all variations of a packet have their own id",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "tabCompleteHasNoToolTip",
+    "description": "tab complete doesn't have a tool tip",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "tabCompleteHasAToolTip",
+    "description": "tab complete has a tool tip",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "effectAreMinecraftPrefixed",
+    "description": "effect are prefixed by minecraft:",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "effectAreNotPrefixed",
+    "description": "effect are not prefixed",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "itemsAreAlsoBlocks",
+    "description": "items are also blocks",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "itemsAreNotBlocks",
+    "description": "items are not block",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "fishingBobberCorrectlyNamed",
+    "description": "the fishing hook entity is named fishing_bobber",
+    "versions": ["1.14", "1.18.2"]
+  },
+  {
+    "name": "editBookIsPluginChannel",
+    "description": "book editing is handled through plugin channels",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "hasEditBookPacket",
+    "description": "book editing is handled through a packet",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "clientUpdateBookIdWhenSign",
+    "description": "when sending MC|BSign, item type should be written_book",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "useMCTrSel",
+    "description": "select trade through plugin channel MC|TrSel",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "useMCTrList",
+    "description": "receive trade list through plugin channel MC|TrList",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "usetraderlist",
+    "description": "receive trade list through plugin channel usetrader_list",
+    "versions": ["1.13", "1.13.2"]
+  },
+  {
+    "name": "doesntHaveOffHandSlot",
+    "description": "doesn't have an off-hand slot",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "dimensionIsAnInt",
+    "description": "description is an int (an enum)",
+    "versions": ["1.8", "1.15.2"]
+  },
+  {
+    "name": "dimensionIsAString",
+    "description": "description is a string",
+    "versions": ["1.16", "1.16.1"]
+  },
+  {
+    "name": "dimensionIsAWorld",
+    "description": "description is a world name (string)",
+    "versions": ["1.16.2", "1.18.2"]
+  },
+  {
+    "name": "dimensionDataIsAvailable",
+    "description": "dimensionData is available, describing additional dimension information",
+    "versions": ["1.17", "1.18.2"]
+  },
+  {
+    "name": "doesntHaveChestType",
+    "description": "chests don't have a type property",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "usesAdvCdm",
+    "description": "packet MC|AdvCmd was incorrectly spelled in 1.8 as MC|AdvCdm",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "usesAdvCmd",
+    "description": "uses MC|AdvCmd to set command block information",
+    "versions": ["1.9", "1.12.2"]
+  },
+  {
+    "name": "indexesVillagerRecipes",
+    "description": "gives a index for each trade in a villagers metadata",
+    "versions": ["1.8", "1.11.2"]
+  },
+  {
+    "name": "hasAttackCooldown",
+    "description": "if there is a cooldown after attacks to deal full damage",
+    "versions": ["1.9", "1.18.2"]
+  },
+  {
+    "name": "usesLoginPacket",
+    "description": "uses the login packet as defined in mcData",
+    "versions": ["1.16", "1.18.2"]
+  },
+  {
+    "name": "usesMultiblockSingleLong",
+    "description": "in the multi_block_change packet is stored as a single number",
+    "versions": ["1.16.2", "1.18.2"]
+  },
+  {
+    "name": "usesMultiblock3DChunkCoords",
+    "description": "in the multi_block_change packet, all 3 axis coords are defined",
+    "versions": ["1.16.2", "1.18.2"]
+  },
+  {
+    "name": "setBlockUsesMetadataNumber",
+    "description": "the parameter metadata of the setblock command is a number",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "useMCItemName",
+    "description": "send item name for anvil using plugin channel MC|TrList",
+    "versions": ["1.8", "1.12.2"]
+  },
+  {
+    "name": "selectingTradeMovesItems",
+    "description": "selecting a trade automatically puts the required items into trading slots",
+    "versions": ["1.14", "1.18.2"]
+  },
+  {
+    "name": "resourcePackUsesHash",
+    "description": "resource pack uses hash validation",
+    "versions": ["1.8", "1.9.4"]
+  },
+  {
+    "name": "lessCharsInChat",
+    "description": "max chars in chat",
+    "versions": ["1.8", "1.10.2"]
+  },
+  {
+    "name": "teamUsesChatComponents",
+    "description": "teams use chatcomponents for formatting",
+    "versions": ["1.13", "1.18.2"]
+  },
+  {
+    "name": "teamUsesScoreboard",
+    "description": "teams use scoreboard_team packet",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "enderCrystalNameEndsInErNoCaps",
+    "description": "this is when the end_crystal's entity name is ender_crystal",
+    "versions": ["1.11", "1.12.2"]
+  },
+  {
+    "name": "enderCrystalNameNoCapsWithUnderscore",
+    "description": "this is when the end_crystal's entity name is end_crystal",
+    "versions": ["1.14", "1.18.2"]
+  },
+  {
+    "name": "entityNameUpperCaseNoUnderscore",
+    "description": "this is when some entities names would be captialized and appended without underscores like 'Boat' or 'ArmorStand'",
+    "versions": ["1.8", "1.10.2"]
+  },
+  {
+    "name": "entityNameLowerCaseNoUnderscore",
+    "description": "this is when some entity names are lowercase and appended without underscores like 'armorstand' or 'endercrystal'",
+    "versions": ["1.13", "1.13.2"]
+  },
+  {
+    "name": "transactionPacketExists",
+    "description": "this is when the description packet existed",
+    "versions": ["1.8", "1.16.5"]
+  },
+  {
+    "name": "stateIdUsed",
+    "description": "starting in 1.17.1, actionId has been replaced with stateId",
+    "versions": ["1.17.1", "1.18.2"]
+  },
+  {
+    "name": "actionIdUsed",
+    "description": "pre 1.17, actionId is used",
+    "versions": ["1.8", "1.16.5"]
+  },
+  {
+    "name": "setSlotAsTransaction",
+    "description": "use setslot as transaction instead of just hoping it'll work",
+    "versions": ["1.17", "1.18.2"]
+  },
+  {
+    "name": "armAnimationBeforeUse",
+    "description": "arm animation packet sent before use entity packet",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "tallWorld",
+    "description": "world y defaults to starts at -64 and ends at 384",
+    "versions": ["1.18", "1.18.2"]
+  },
+  {
+    "name": "sendStringifiedSignText",
+    "description": "sign text send when updating signs is send as stringified strings",
+    "versions": ["1.8", "1.8.9"]
+  }
+]

package/minecraft-data/doc/history.md

@@ -1,3 +1,12 @@
+## 2.115.1
+* Fix name conflict with existing "version" and type from features.json
+
+## 2.115.0
+* Add features.json from mineflayer
+
+## 2.114.1
+* fix 1.18.2 data paths
+
 ## 2.114.0
 * mcpc 1.18.2 protocol support
 

package/minecraft-data/schemas/features_schema.json

@@ -0,0 +1,32 @@
+{
+  "title": "features",
+  "type": "array",
+  "uniqueItems": true,
+  "items": {
+    "title": "featureEntry",
+    "type": "object",
+    "properties": {
+      "name": {
+        "description": "The name of the feature",
+        "type": "string",
+        "pattern": ".+"
+      },
+      "description": {
+        "description": "The description of the feature",
+        "type": "string",
+        "pattern": ".+"
+      },
+      "versions": {
+        "description": "A tuple that describes the range of versions in the range",
+        "type": "array",
+        "uniqueItems": true,
+        "items": {
+          "title": "versionForFeatureIdentification",
+          "type": "string",
+          "minItems": 2,
+          "additionalItems": false
+        }
+      }
+    }
+  }
+}

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

@@ -41,7 +41,7 @@ require('./version_iterator')(function (p, versionString) {
   })
 })
 
-const commonData = ['protocolVersions']
+const commonData = ['protocolVersions', 'features']
 const minecraftTypes = ['pc', 'bedrock']
 
 minecraftTypes.forEach(function (type) {

package/package.json

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