PrismarineJS / PrismarineJS/minecraft-data

Unindex recipes and materials

Open
#22 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

schema change
Dominant language
JavaScript
Stars
938
Forks
294
Avg merge
2d 10h
Merged PRs (30d)
23

Description

Not having an index in json files makes it easier for users to index by what they need. That means the data doesn't have to change if one index or an other becomes more pratical (id vs id:metadata vs name ,... ). It also makes it possible to consider one element as a document of a database.

All json files are now unindexed except for recipes and materials.

I think materials could have a format like this :

{
  "material":"rock",
  "multipliers":  {
    "257": 6,
    "270": 2,
    "274": 4,
    "278": 8,
    "285": 12
  }
}

I'm not sure whether multipliers should be unindexed too since it only has one value, maybe.

The recipes file is currently indexed by output id. The simplest solution might be to just remove that indexing, and to say that the recipes should be ordered by a lexicographic order on (id,metadata) in order to have a decent diff.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the recipes and materials JSON files with the other already-unindexed data files, then trace consumers that rely on their current indexing. Resolve the open question about indexing multipliers and define the recipe ordering before removing the remaining indexes; done means both datasets follow the agreed format and consumers still load them correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.