# Pumpkin Plugins

> TypeScript plugins, shared tools, and GitHub Actions for Pumpkin Minecraft servers.

Plugins are WebAssembly components that run in Pumpkin's QuickJS runtime. Source links below return Markdown from the repository; generated API links point to the [documentation site](https://filiphsps.github.io/pumpkin-plugins/). This file is generated from discovered guides, component documentation, package metadata, and API references.

## Getting started

- [Documentation index](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/README.md): Catalog of guides and documentation pages.
- [Creating a plugin](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/creating-a-plugin.md): This runs the plugin generator (a Turborepo generator, defined in turbo/generators/).
- [Creating an action](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/creating-an-action.md): This runs the action Turborepo generator in turbo/generators/.
- [Documentation site](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/documentation-site.md): The VitePress site combines the hand-written guides in docs/, component READMEs, component-level guides, and generated API references.

## Plugin development

- [Building](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/building.md): pumpkin-plugins-build (tools/build) turns a plugin into a .wasm component.
- [Code style](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/code-style.md): pnpm lint runs two linters, and CI runs the same command.
- [Plugin config](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/plugin-config.md): Plugins that need settings use @pumpkin-plugins/config (tools/config).
- [Plugin info and READMEs](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/plugin-info-and-readmes.md): Each plugin describes itself in one small module that exports info.
- [Testing](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/testing.md): Each plugin has two vitest projects, set up by definePluginVitestConfig() from @pumpkin-plugins/test-harness/vitest.

## Repository maintenance

- [Agent tooling](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/agent-tooling.md): The repo keeps agent instructions, skills and executable checks separate.
- [CI and releases](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/ci-and-releases.md): The plugin and release jobs are in .github/workflows/ci.yml; action tests have their own .github/workflows/actions.yml, scoped to action code.

## Server operations

- [Checking for plugin updates](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/plugin-updates.md): Every plugin in this repository checks Pumpkin Market after it loads.
- [Port forwarding](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/port-forwarding.md): Players can only reach a server behind a home router when the router forwards the server's ports.
- [Pumpkin Market API](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/docs/pumpkin-market-api.md): This page records the Market API behavior used by this repository's publish action, the Market frontend, and PPM.

## Plugins

- [AppleSkinPumpkin](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/apple-skin-pumpkin/docs/index.md): AppleSkin server-side support
- [AppleSkinPumpkin README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/apple-skin-pumpkin/README.md): Additional component overview and usage details.
- [BedrockAddonManager](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/bedrock-addon-manager/docs/index.md): Serves Bedrock packs over HTTP; Pumpkin can't send them to players yet
- [BedrockAddonManager README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/bedrock-addon-manager/README.md): Additional component overview and usage details.
- [BedrockAddonManager: Set up Bedrock packs](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/bedrock-addon-manager/docs/setup.md): The folder is scanned at startup and on /baddon reload; new files are not detected automatically.
- [BedrockAddonManager: Troubleshoot Bedrock pack hosting](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/bedrock-addon-manager/docs/troubleshooting.md): Check that web.enabled is true, the pack appears in /baddon list, and the configured bind address and port are reachable through the server firewall.
- [Distant Horizons Support Pumpkin](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/distant-horizons-support-pumpkin/docs/index.md): Unofficial Distant Horizons server support for Pumpkin
- [Distant Horizons Support Pumpkin README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/distant-horizons-support-pumpkin/README.md): Additional component overview and usage details.
- [Distant Horizons Support Pumpkin: Install and connect](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/distant-horizons-support-pumpkin/docs/setup.md): Before installing, check the plugin README for the supported Distant Horizons release and protocol.
- [Distant Horizons Support Pumpkin: Troubleshooting](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/distant-horizons-support-pumpkin/docs/troubleshooting.md): Confirm the client uses the supported Distant Horizons release listed in the plugin README.
- [DynamicLightsPumpkin](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/dynamic-lights-pumpkin/docs/index.md): Server-side dynamic lights for held light sources
- [DynamicLightsPumpkin README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/dynamic-lights-pumpkin/README.md): Additional component overview and usage details.
- [DynamicLightsPumpkin: Configure light sources](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/dynamic-lights-pumpkin/docs/configuration.md): Settings live in plugins/data/DynamicLightsPumpkin/config.toml.
- [UPnPumpkin](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/upnpumpkin/docs/index.md): Opens router ports for Pumpkin with UPnP and NAT-PMP
- [UPnPumpkin README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/upnpumpkin/README.md): Additional component overview and usage details.
- [UPnPumpkin: Troubleshoot port forwarding](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/upnpumpkin/docs/troubleshooting.md): Confirm UPnP or NAT-PMP is enabled in the router settings and that the server host shares the router's local network.
- [Waypoints](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/waypoints/docs/index.md): Server-managed waypoints with access rules and vanilla commands
- [Waypoints README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/waypoints/README.md): Additional component overview and usage details.
- [Waypoints: Waypoint HUD preview](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/packages/waypoints/docs/hud-preview.md): This build is ready for local preview testing.

## Shared tools

- [Plugin build tool](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/build/docs/index.md): Shared build tool for the plugins
- [Plugin build tool README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/build/README.md): Additional component overview and usage details.
- [Plugin configuration library](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/config/docs/index.md): Schema-driven TOML config for plugins
- [Plugin configuration library README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/config/README.md): Additional component overview and usage details.
- [Documentation generator](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/docs/docs/index.md): Generates component READMEs, doc links, and repository catalogs
- [Documentation generator README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/docs/README.md): Additional component overview and usage details.
- [Minecraft colors](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/minecraft-colors/docs/index.md): Chalk-like Minecraft text formatting for plugins
- [Minecraft colors README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/minecraft-colors/README.md): Additional component overview and usage details.
- [Plugin kit](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/plugin-kit/docs/index.md): Host helpers shared by plugins
- [Plugin kit README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/plugin-kit/README.md): Additional component overview and usage details.
- [Port mapping library](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/port-mapping/docs/index.md): UPnP and NAT-PMP port mapping
- [Port mapping library README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/port-mapping/README.md): Additional component overview and usage details.
- [Pumpkin plugin signing](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/signing/docs/index.md): Ed25519 signing for plugin builds
- [Pumpkin plugin signing README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/signing/README.md): Additional component overview and usage details.
- [Terrain capture](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/terrain/docs/index.md): Shared terrain capture and access contracts
- [Terrain capture README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/terrain/README.md): Additional component overview and usage details.
- [Pumpkin test harness](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/test-harness/docs/index.md): Runs plugins on a real Pumpkin in vitest
- [Pumpkin test harness README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/test-harness/README.md): Additional component overview and usage details.
- [Pumpkin Market update checks](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/update-check/docs/index.md): Check plugin versions against Pumpkin Market
- [Pumpkin Market update checks README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/update-check/README.md): Additional component overview and usage details.
- [UPnPumpkin plugin API](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/upnpumpkin-api/docs/index.md): Asks UPnPumpkin to open a port
- [UPnPumpkin plugin API README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/tools/upnpumpkin-api/README.md): Additional component overview and usage details.

## GitHub Actions

- [Publish a plugin to Pumpkin Market](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/publish-to-pumpkin-market/docs/index.md): Upload a released Pumpkin plugin WebAssembly file to its existing Market listing
- [Publish a plugin to Pumpkin Market README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/publish-to-pumpkin-market/README.md): Additional component overview and usage details.
- [Sign Pumpkin plugins](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/sign-pumpkin-plugin/docs/index.md): Sign Pumpkin plugin WebAssembly files with their Ed25519 release metadata
- [Sign Pumpkin plugins README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/sign-pumpkin-plugin/README.md): Additional component overview and usage details.
- [Update a Pumpkin Market listing](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/update-pumpkin-market-listing/docs/index.md): Update Pumpkin Market listing metadata from a JSON file or direct inputs
- [Update a Pumpkin Market listing README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/update-pumpkin-market-listing/README.md): Additional component overview and usage details.
- [Verify Pumpkin plugin signatures](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/verify-pumpkin-plugin/docs/index.md): Verify Pumpkin plugin signatures with optional public-key pinning and metadata checks
- [Verify Pumpkin plugin signatures README](https://raw.githubusercontent.com/filiphsps/pumpkin-plugins/master/actions/verify-pumpkin-plugin/README.md): Additional component overview and usage details.

## API reference

- [Overview reference](https://filiphsps.github.io/pumpkin-plugins/api/): Generated API and action contract documentation.
- [Plugins reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/): Generated API and action contract documentation.
- [Tools reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/): Generated API and action contract documentation.
- [Actions reference](https://filiphsps.github.io/pumpkin-plugins/api/actions/): Generated API and action contract documentation.
- [Scripts reference](https://filiphsps.github.io/pumpkin-plugins/api/scripts/): Generated API and action contract documentation.
- [AppleSkinPumpkin API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/apple-skin-pumpkin/): AppleSkin server-side support
- [BedrockAddonManager API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/bedrock-addon-manager/): Serves Bedrock packs over HTTP; Pumpkin can't send them to players yet
- [Distant Horizons Support Pumpkin API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/distant-horizons-support-pumpkin/): Unofficial Distant Horizons server support for Pumpkin
- [DynamicLightsPumpkin API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/dynamic-lights-pumpkin/): Server-side dynamic lights for held light sources
- [UPnPumpkin API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/upnpumpkin/): Opens router ports for Pumpkin with UPnP and NAT-PMP
- [Waypoints API reference](https://filiphsps.github.io/pumpkin-plugins/api/plugins/waypoints/): Server-managed waypoints with access rules and vanilla commands
- [Plugin build tool API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/build/): Shared build tool for the plugins
- [Plugin configuration library API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/config/): Schema-driven TOML config for plugins
- [Documentation generator API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/docs/): Generates component READMEs, doc links, and repository catalogs
- [Minecraft colors API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/minecraft-colors/): Chalk-like Minecraft text formatting for plugins
- [Plugin kit API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/plugin-kit/): Host helpers shared by plugins
- [Port mapping library API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/port-mapping/): UPnP and NAT-PMP port mapping
- [Pumpkin plugin signing API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/signing/): Ed25519 signing for plugin builds
- [Terrain capture API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/terrain/): Shared terrain capture and access contracts
- [Pumpkin test harness API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/test-harness/): Runs plugins on a real Pumpkin in vitest
- [Pumpkin Market update checks API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/update-check/): Check plugin versions against Pumpkin Market
- [UPnPumpkin plugin API API reference](https://filiphsps.github.io/pumpkin-plugins/api/tools/@pumpkin-plugins/upnpumpkin-api/): Asks UPnPumpkin to open a port
- [Publish a plugin to Pumpkin Market API reference](https://filiphsps.github.io/pumpkin-plugins/api/actions/publish-to-pumpkin-market/): Upload a released Pumpkin plugin WebAssembly file to its existing Market listing
- [Sign Pumpkin plugins API reference](https://filiphsps.github.io/pumpkin-plugins/api/actions/sign-pumpkin-plugin/): Sign Pumpkin plugin WebAssembly files with their Ed25519 release metadata
- [Update a Pumpkin Market listing API reference](https://filiphsps.github.io/pumpkin-plugins/api/actions/update-pumpkin-market-listing/): Update Pumpkin Market listing metadata from a JSON file or direct inputs
- [Verify Pumpkin plugin signatures API reference](https://filiphsps.github.io/pumpkin-plugins/api/actions/verify-pumpkin-plugin/): Verify Pumpkin plugin signatures with optional public-key pinning and metadata checks