mcbe-item-ids

A monorepo for packages working with Minecraft Bedrock Edition item IDs, containing tools to scrape, generate, and use item ID data.

Packages

mcbe-item-ids (generated)

Type: Library
Description: Minecraft Bedrock Edition item IDs exported as a TypeScript/JavaScript module.

This package is automatically generated by mcbe-item-ids-packgen based on the template mcbe-item-ids-package-template and the JSON data scraped with mcbe-item-ids-scraper from the official Microsoft documentation.

Installation:

npm install mcbe-item-ids

Usage:

import { itemIds } from 'mcbe-item-ids';

console.log(itemIds);

For usage, see https://www.npmjs.com/package/mcbe-item-ids.

---

mcbe-item-ids-scraper

Type: CLI Tool
Description: A TypeScript CLI tool to scrape and extract Minecraft Bedrock Edition item IDs from the official Microsoft documentation.

Features:

• Fetches HTML from Microsoft's official Minecraft documentation
• Parses item IDs from HTML tables
• Outputs JSON with timestamped filenames
• Optional HTML saving with --save-html flag
• Maintains latest.json for easy access to most recent data

Usage:

cd mcbe-item-ids-scraper
npm install
npm run dev

---

mcbe-item-ids-packgen

Type: CLI Tool
Description: A TypeScript CLI tool that generates the mcbe-item-ids package by fetching the latest scraped data and creating a complete npm package from the template.

Features:

• Fetches latest item IDs JSON from GitHub
• Copies and customizes template files
• Generates ready-to-publish package
• Automatically updates package metadata

Usage:

cd mcbe-item-ids-packgen
npm install
npm run dev

---

mcbe-item-ids-package-template

Type: Template
Description: A TypeScript library template used by mcbe-item-ids-packgen to generate the mcbe-item-ids package.

This template provides the base structure, configuration, and code that gets customized during package generation.

Workflow

For usage (applies to most users), see https://www.npmjs.com/package/mcbe-item-ids.

npm install mcbe-item-ids

For development,

# Run full development workflow (scrape, generate, test)
cd mcbe-item-ids-packgen
npm install
npm run dev:fresh

# Publish (build runs automatically via prepublishOnly)
cd ../mcbe-item-ids
npm publish

Or manually step-by-step:

# 1. Scrape item IDs from Microsoft documentation
cd mcbe-item-ids-scraper
npm install
npm run scrape:latest

# 2. Generate the mcbe-item-ids package
cd ../mcbe-item-ids-packgen
npm install
npm run dev:local

# 3. Test the generated package
cd ../mcbe-item-ids
npm install
npm test

# 4. Publish (build runs automatically via prepublishOnly)
npm publish

Repository Structure

mcbe-item-ids/
├── mcbe-item-ids/                    # Generated library package
├── mcbe-item-ids-scraper/            # Web scraper CLI tool
├── mcbe-item-ids-packgen/            # Package generator CLI tool
├── mcbe-item-ids-package-template/   # Template for generated package
└── README.md                         # This file

License

ISC