> ## Documentation Index
> Fetch the complete documentation index at: https://pumpkings.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Install PumpkinAnnouncer on Paper or Velocity Servers

> Install PumpkinAnnouncer with a single JAR — drop it into your Paper or Velocity plugins folder, restart, and edit the generated config to get started.

PumpkinAnnouncer ships as a single JAR that works on both Paper servers and Velocity proxies. When the plugin loads, it detects your platform automatically and writes the correct configuration file to its data directory. You do not need separate downloads or different builds for each platform.

## Requirements

* **Java 17 or newer**
* **Paper** (API version 1.19+) **or Velocity** (any modern release)
* **PlaceholderAPI** — optional soft dependency, Paper only; install it if you want `%placeholder%` tokens to resolve per-player

## Installation steps

<Tabs>
  <Tab title="Paper">
    <Steps>
      <Step title="Download the JAR">
        Download `PumpkinAnnouncer-2.4.jar` from [Modrinth](https://modrinth.com/plugin/pumpkinannouncer) or your preferred source.
      </Step>

      <Step title="Drop the JAR into your plugins folder">
        Copy the JAR into your server's `plugins/` directory.

        ```bash theme={null}
        cp PumpkinAnnouncer-2.4.jar /path/to/server/plugins/
        ```
      </Step>

      <Step title="Restart the server">
        Restart your Paper server (a full restart, not a reload). PumpkinAnnouncer writes its default configuration on first boot.
      </Step>

      <Step title="Edit the configuration">
        Open `plugins/PumpkinAnnouncer/paper-config.yml` in a text editor and customise your announcements, cooldown, and messages.

        ```bash theme={null}
        nano plugins/PumpkinAnnouncer/paper-config.yml
        ```
      </Step>

      <Step title="Apply your changes">
        Run `/pa reload` in-game or from the server console to pick up your edits without a full restart.
      </Step>
    </Steps>

    <Note>
      PlaceholderAPI is detected automatically at startup. Install it before starting your server if you want per-player placeholder support in announcement text.
    </Note>
  </Tab>

  <Tab title="Velocity">
    <Steps>
      <Step title="Download the JAR">
        Download `PumpkinAnnouncer-2.4.jar` from [Modrinth](https://modrinth.com/plugin/pumpkinannouncer) or your preferred source.
      </Step>

      <Step title="Drop the JAR into your plugins folder">
        Copy the JAR into your Velocity proxy's `plugins/` directory.

        ```bash theme={null}
        cp PumpkinAnnouncer-2.4.jar /path/to/velocity/plugins/
        ```
      </Step>

      <Step title="Restart the proxy">
        Restart your Velocity proxy. PumpkinAnnouncer detects Velocity automatically and writes the default configuration on first boot.
      </Step>

      <Step title="Edit the configuration">
        Open `plugins/pumpkinannouncer/velocity-config.yml` in a text editor and customise your announcements, server filters, cooldown, and messages.

        ```bash theme={null}
        nano plugins/pumpkinannouncer/velocity-config.yml
        ```
      </Step>

      <Step title="Apply your changes">
        Run `/pa reload` in-game or from the Velocity console to reload the configuration without restarting the proxy.
      </Step>
    </Steps>

    <Note>
      PlaceholderAPI is a Paper-only integration. It is not available on Velocity, so `%placeholder%` tokens are left as-is on the proxy platform.
    </Note>
  </Tab>
</Tabs>

## Update notifications

When a new version of PumpkinAnnouncer is available on Modrinth, any online player who holds the `pumpkin.admin` permission sees a clickable in-chat notification on join. The message shows your current version, the latest version, and a one-click download link. No action is required — the check runs automatically in the background at startup.