Skip to content

Documentation ​

PageWhat it covers
TeamPeople contributing to Pumpkin Plugins
HomeDocumentation site landing page
Documentation siteAdding component guides, generated API reference, local preview, and publishing
Creating a pluginThe pnpm gen generator, what it creates, and what to do next
Creating an actionThe pnpm gen:action generator, generated input/output docs, and release setup
Plugin info and READMEsHow a plugin describes itself in src/info.ts and how the READMEs are generated
Plugin configDeclaring settings as a schema: the file, validation, upgrades and docs all come from it
Checking for plugin updatesChecking plugin versions against Pumpkin Market
Pumpkin Market APIMarket listing lookup, metadata updates, current publisher behavior and API findings
Code styleBiome, the JSDoc rule, and how code is organized and tested
BuildingThe shared build tool, Turborepo setup, and the QuickJS runtime caveats
TestingUnit tests and integration tests against a real Pumpkin server
Port forwardingUPnP and NAT-PMP for plugins: the engine, UPnPumpkin, its API and how to test them
CI and releasesThe CI workflow, release-please, rebase-only merging and the market stub
Agent toolingAgent guidance, skills, portable hooks and scoped check diagnostics

Pumpkin Plugins documentation