PrismarineJS / PrismarineJS/minecraft-data
Generating notes from wiki.vg using the protocol extractor script to put in protocol.json
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 938
- Forks
- 294
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 25
Description
See https://gist.github.com/rom1504/7b4c0cc29fb03122b6a5#relation-with-wikivgprotocol and https://github.com/PrismarineJS/minecraft-data/blob/master/bin/wiki_extractor/protocol_extractor.js
Would also be useful to work on having a .md from wiki.vg/Protocol for each packet description (also explained in the gist)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with bin/wiki_extractor/protocol_extractor.js and the linked gist section on the relationship with wiki.vg protocol data. Compare the extractor's output with protocol.json, then determine how the same source should produce a Markdown file for each packet description. Done means the generated protocol data and per-packet notes match the wiki.vg protocol descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100