Skip to content

feat(velocity): document velocity-plugin.json file#735

Open
Strokkur424 wants to merge 2 commits intomainfrom
feat/velocity-plugin-json
Open

feat(velocity): document velocity-plugin.json file#735
Strokkur424 wants to merge 2 commits intomainfrom
feat/velocity-plugin-json

Conversation

@Strokkur424
Copy link
Member

closes #731

I actually decided against outright removing mentions of the AP, as it is useful for beginners and honestly doesn't really hurt most people. But having the actual file documented seems like a good thing.

@Strokkur424 Strokkur424 added dev guide This issue or PR aims to introduce developer API documentation project: Velocity labels Feb 21, 2026
@github-actions
Copy link

github-actions bot commented Feb 21, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

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

@Timongcraft
Copy link
Contributor

I think it should either be mentioned what the name and ID are actually for, because most logging just uses the ID so either that should be refactored, or this behaviour be documented. (The name is also mostly in-game facing)
I'm also not sure why you omitted parts of the spec in your example, because I think the author/url field is a good source indicator, that should be recommended.
Also I think this page could be a bit more compact, like putting a required indicator in your example or in the header of the entries itself and/or not have these giant spaces.
Lastly IMO the page should be under the "Creating your first plugin" page or be a sub-page and be mentioned in the:
https://papermc-feat-velocity-plugin.papermc-docs.pages.dev/velocity/dev/creating-your-first-plugin/#setting-up-the-dependency section, not just the file itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev guide This issue or PR aims to introduce developer API documentation project: Velocity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the Velocity plugin JSON file format

3 participants