mark-wiemer / minecraft-item-db

A simple utility to generate item metadata from the Minecraft Wiki

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Minecraft item DB

A simple item database generated from Minecraft Wiki. Includes instructions to regenerate the database when Minecraft Wiki updates.

Overall design

  1. Get list of all items from https://minecraft.fandom.com/wiki/Category:Items
  2. Fetch the wiki page for each individual item (e.g. https://minecraft.fandom.com/wiki/Amethyst_Shard)
  3. Extract the relevant information from the wiki page
  4. Add the info to a row in the DB
  5. Repeat for all items

Building from source

Machine dependencies

  1. NodeJS
  2. npm (comes with NodeJS)
  3. Visual Studio Code

Project setup

  1. Clone this project into a new repo
  2. npm i
  3. You're done!

Optional:

  1. Install the recommended VS Code extensions
  2. Enable `keybindings.json following the instructions in that file

Notes

This project was copied from hello-npm and has some unused dependencies that I don't care to remove right now :D

Why Bash?

I know it's not the most platform-independent system. But this is also a good learning opportunity for me! So that's why!

About

A simple utility to generate item metadata from the Minecraft Wiki


Languages

Language:HTML 94.0%Language:Shell 6.0%