PrismarineJS / PrismarineJS/node-minecraft-protocol
Refactoring Client to extend Stream.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 290
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 7
Description
I think client should be build on top of a stream.
so you can do
client.pipe(fs.createWriteStream('protocol.log'))
client.pipe(new Transform({ writableObjectMode: true, transform(chunk, enc, cb) {
this.push(JSON.stringify(chunk,null,2);
cb();
}})).pipe(fs.createWriteStream('protocol.log'));
stream -> [ serializer ] -> [ compressor ] -> framer -> [ cipher ] -> socket
socket -> [ decipher ] -> splitter -> [ decompressor ] -> deseralizer -> stream
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
The issue names the JavaScript client and a stream-based protocol pipeline, but no files, tests, or entry points. Start by locating the client implementation and its socket, framing, serialization, compression, and encryption flow. Done would mean the client supports the proposed stream pipeline, with coverage for the resulting behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- networking
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100