PaperMC / PaperMC/Velocity

Improve plugin messaging data API

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

Nobody has claimed this yet.

type: feature
Dominant language
Java
Stars
2.3k
Forks
959
Avg merge
5d 10h
Merged PRs (30d)
2

Description

In Velocity 2.0.0, we intend to make plugin message data buffers be based on a generic data type API (built on top of Netty).

The old getData() and dataAsDataStream() methods will be available in a transitionary release between 1.1.0 and 2.0.0, but will be deprecated and removed in Velocity 2.0.0.

Contributor guide

Open the contributing guide

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

The issue identifies the existing getData() and dataAsDataStream() methods but names no files or tests. Start by locating those methods and the plugin messaging data-buffer API, then determine the generic data type API and transition behavior required. Done means the new API is defined while the old methods are deprecated for the transition and removed in Velocity 2.0.0.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend-api-design
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.