PrismarineJS / PrismarineJS/node-minecraft-protocol

Slot data documentation

Open
#604 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
1.4k
Forks
290
Avg merge
4d 8h
Merged PRs (30d)
7

Description

Issue

Documentation is wrong about slot datas (i assume)

Solution

I spent almost an hour to understand that content was in fact just a prismarine item.toNotch.
Would be nice for new users to precise explicitly this matter in docs somehow.

The correct format is the following (or maybe i just don't know how to read the doc table ?)

import prismarineItem from "prismarine-item"
const Item = prismarineItem('1.12.1')

const stick = new Item(280, 5)
const notchStick = Item.toNotch(stick)
this.client.write('window_items', {
    windowId: 0,
    items: [0, 0, 0, notchStick, notchStick, 0, notchStick],
})

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

Locate the slot data documentation and its table, then compare the description of content with the issue's Item.toNotch(stick) example. Update the documentation to explicitly state the expected content format and ensure the example matches it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.