Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.49 KB

readme.md

File metadata and controls

88 lines (60 loc) · 2.49 KB

Latest version Last updated npm downloads

Minecraft Versions

A complete list of all Minecraft versions and their metadata, for Java and Bedrock, releases and snapshots.

Install

Minecraft-Versions is available on npm.

Install locally using npm install minecraft-vers@latest-0.x to use in a Node project.

Install globally using npm install -g minecraft-vers@latest-0.x to use the CLI.

Usage

Node:

const versionData = require('minecraft-vers') // old import syntax
/*or*/
import versionData from 'minecraft-vers' // modern import syntax

Command-line:

mcdata [--full] <edition> <phase> [<version>] [<index>] [<param>]

Output format

{
  "<edition>": { // Java | Bedrock | ...
    "<phase>":  { // Release | Beta | ....
      "<version>": [ // 1.17 | 1.16.5-rc1 | ...
        {
          "name": "<in-game name>",
          "type": "release|snapshot",
          "parent": "null|<parent>|{phase:<phase>,version:<parent>}", // null | '1.16.3' | {phase: Release, version: 1.0.0} | ...
          "date": "<timestamp>",
        }
      ]
    }
  }
}

Examples

Command-line:

$ mcdata Java Beta 1.8
[{ "name": "Beta 1.8", "type": "release", "parent": null, "date": 2011-09-14 }]

Node:

const versionData = require('minecraft-vers')

console.log(versionData.Java.Release['1.17'])
// [{ "name": "1.17", "type": "release", "parent": null, "date": 2021-06-08 }]

console.log(versionData.Java.Beta['1.8-pre1'][0])
// { "name": "Beta 1.8 Pre-release", "type": "snapshot", "parent": "Beta 1.8", "date": 2011-09-08 }

console.log(versionData.Java.Release['1.6.3'][1].type)
// "snapshot"

Data source

Omniarchive index, excluding speculative (yellow-shaded) versions.

Contributing

Version information is stored in the data folder.

Use node script/add to add an entry to the files.

License

This data is released into the public domain and can be used for any purpose.