Skip to content

feat(paper): document using your own plugin messaging channel - #825

Open
spa77k wants to merge 1 commit into
PaperMC:mainfrom
spa77k:feat/plugin-messaging-custom-channels
Open

spa77k wants to merge 1 commit into
PaperMC:mainfrom
spa77k:feat/plugin-messaging-custom-channels

Conversation

@spa77k

@spa77k spa77k commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Closes #740.

Adds a "Using your own channel" section to the Paper plugin messaging page:

  • Using a custom channel (e.g. myplugin:main) instead of BungeeCord, with an example that registers it and sends and receives messages on it.
  • A caution that Paper only sends a plugin message if the player's connection has registered the channel with minecraft:register, and otherwise silently drops it, as mentioned in the issue. It explains how the other end registers the channel: Velocity's ChannelRegistrar (linking to the Velocity plugin messaging page), BungeeCord's ProxyServer#registerChannel, or the client-side mod itself.
  • A note that incoming messages need no such registration, so players can also send messages on the channel.

The behavior was checked against the source:

  • Paper: CraftPlayer#sendPluginMessage (only sends if channels() contains the channel), the minecraft:register handling in ServerCommonPacketListenerImpl, and StandardMessenger#validateAndCorrectChannel.
  • Velocity: ClientPlaySessionHandler#handleBackendJoinGame registers the ChannelRegistrar channels with the backend server.
  • BungeeCord: ServerConnector sends registerChannels to the backend server.

Verification:

  • pnpm build and prettier --check on the changed file passed, and the new jd: links resolve to existing Javadoc pages.

@github-actions

github-actions Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview ea4c8aa

This branch was successfully deployed

1 active deployment
Preview — ea4c8aaf Deployed Oct 28, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement to Plugin messaging on dev documentation:

1 participant