Skip to content

Installation

DynaDev edited this page Aug 12, 2026 · 1 revision

Installation

Requirements

Before installing TownyAlerts, make sure the server already has:

  • Towny
  • DiscordSRV
  • A supported Java runtime
  • Paper or Purpur for modern Towny versions

TownyAlerts does not create its own Discord bot. DiscordSRV must already be configured and connected.

Install

  1. Stop the Minecraft server.
  2. Place the TownyAlerts JAR in:
plugins/
  1. Start the server.
  2. TownyAlerts will create its data folder:
plugins/TownyAlerts/
  1. Edit:
plugins/TownyAlerts/config.yml
  1. Configure at minimum:
discord:
  channel-id: "YOUR_DISCORD_CHANNEL_ID"
  1. Restart the server, or use:
/townyalerts reload
  1. Verify the integration:
/townyalerts status
  1. Send a test alert:
/townyalerts test

First startup

By default, TownyAlerts also creates:

plugins/TownyAlerts/languages/en-us.yml
plugins/TownyAlerts/languages/es-cl.yml

Existing language files are not overwritten automatically.

No database is required

The default storage backend is:

storage:
  type: memory

This keeps all deduplication state in memory and creates no database file.

If persistent history is wanted, see the Storage page.

Discord permissions

The DiscordSRV bot must be able to access the configured Discord channel and send messages there.

If TownyAlerts can detect DiscordSRV but cannot send a test message, check the channel permissions assigned to the DiscordSRV bot.

Clone this wiki locally