PrismarineJS / PrismarineJS/minecraft-data

constants.json

Open
#93 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There are several universal constant values that are just key-value mappings and have in common that they do not fit into any of the present formats.

  • QUICK_BAR_COUNT and INVENTORY_SLOT_COUNT
    • these are not and should not be tracked in windows.json, as they don't fit the format
    • note that mineflayer's QUICK_BAR_START is actually INVENTORY_SLOT_COUNT
  • CROUCH_HEIGHT and PLAYER_HEIGHT (called NAMED_ENTITY_HEIGHT in mineflayer)
  • several other physics related constants from here and there
    • Which of these are universal enough to be in minecraft-data?
    • How would these be extracted or manually updated?
  • some protocol constants which do not fit into protocol.json
  • probably some others from there, for example
    • BOOK_MAXPAGES, BOOK_CHARS_PER_PAGE
    • gamemode numbers (GM_SURVIVAL etc)
    • CLIENT_TICK_RATE

Example JSON schema:

{
  "GM_SURVIVAL": 0,
  "INVENTORY_SLOT_COUNT": 27
}

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

Start by reviewing the existing data formats and the linked mineflayer physics.js and SpockBot constants.py references. Decide which constants are universal and how they should be maintained, then define constants.json using the proposed mapping schema; done means the selected constants are documented and consistently represented.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.