PaperMC / PaperMC/docs

Document all adventure SPIs

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

Nobody has claimed this yet.

dev guide meta guide project: Adventure
Dominant language
MDX
Stars
73
Forks
280
Avg merge
20h 52m
Merged PRs (30d)
4

Description

Adventure has grown quite a few SPIs that platforms should be implementing. We should have a consolidated location where these are documented. So far, these are:

  • the Providers for component serializers, to customize options
  • the JSONComponentSerializer providers, for different component serializer implementations
  • the DataComponentValueConverter.Provider interface, for controlling conversions between different data component value types
  • the ClickCallback provider, to implement callbacks
  • ComponentLoggerProvider to provide appropriate serializers for component logging

Migrated from https://github.com/KyoriPowered/adventure-docs/issues/167

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

Start by locating the existing Adventure documentation and the five listed SPI entry points: serializer Providers, JSONComponentSerializer providers, DataComponentValueConverter.Provider, ClickCallback, and ComponentLoggerProvider. Done means a single consolidated documentation location covers each SPI and explains its platform implementation purpose.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.