Skip to content

PowerNukkitX-Bundle/UpdateNotifier

Repository files navigation

UpdateNotifier

UpdateNotifier is a lightweight and efficient PowerNukkitX plugin that notifies you when there is a new update available.


✨ Features

  • 🔍 Automatic GitHub update checking
  • Asynchronous (non-blocking) HTTP requests
  • 🧩 Fully configurable notification message
  • 👤 Optional player join notifications
  • 🔐 Permission-based notifications
  • 🛠 Minimal overhead, clean implementation

📦 How It Works

UpdateNotifier compares the current server Git commit with the latest commit on GitHub.

  • If the commits do not match, an update is available.
  • If they match, the server is up to date.
  • The check is performed asynchronously to ensure zero lag.

📁 Configuration

# UpdateNotifier configuration
repository-url: "PowerNukkitX/PowerNukkitX"

notify:
  message: "§5New update is available! You can download it from: §f%repositoryUrl%"
  notify-join: true # Notifies the player if the player has permission "updatenotifier.notify"

🔧 Config Options

repository-url

The GitHub repository to check for updates.

Format:

owner/repository

Example:

PowerNukkitX/PowerNukkitX

notify.message

The message sent when an update is available.

  • Supports Minecraft color codes (§)

  • Supports placeholders:

    • %repositoryUrl% → replaced with the GitHub repository URL

notify.notify-join

If enabled, players will be notified when they join the server, provided they have the correct permission.


🔐 Permissions

Permission Description
updatenotifier.notify Allows the player to receive update notifications on join

🚀 Use Cases

  • Server owners running PowerNukkitX nightly builds
  • Developers tracking upstream changes
  • Administrators who want early update notifications
  • Production servers that require manual update awareness

📌 Requirements

  • A PowerNukkitX server
  • Internet connection (GitHub API access)

📄 License

This project has MIT license.

About

Notifies you when there is a new update available

Resources

License

Stars

Watchers

Forks

Languages