Skip to content

About

Show scheduled announcements to everyone, or only to servers on chosen nodes, locations or eggs.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Announcements

Show scheduled announcements to everyone, or only to servers on chosen nodes, locations or eggs.

Features

  • Panel-wide banners on the dashboard, shown to every user.
  • Targeted banners on the server console page, only for servers on chosen nodes, locations or eggs.
  • Scheduling: optional start and end times. Announcements appear and disappear on their own.
  • Four levels: Information, Good news, Warning and Urgent, styled with the panel's own alert colours so they match any theme.
  • Dismissible or not: users can hide an announcement in their browser. Editing it shows it again. Turn dismissing off for anything people must read.
  • Admin page at Admin → Announcements to create, edit and delete announcements.

API

Method Path Who
GET /api/client/extensions/announcements/active Any signed-in user (panel-wide announcements)
GET /api/client/servers/{server}/extensions/announcements/active Anyone who can see the server
GET, POST /api/admin/extensions/announcements/announcements Root admins
PATCH, DELETE /api/admin/extensions/announcements/announcements/{id} Root admins

Requirements

  • Pterodactyl Panel v2.0.0-beta.1 or later
  • PHP 8.3+

Install

  1. Download announcements-<version>.pteroext from the latest release.
  2. In the panel, open Admin → Extensions, upload the file and enable it.
  3. Reload the panel.

From a terminal instead:

php artisan p:extension:install /path/to/announcements-<version>.pteroext --enable

Build from source

npm install
npm run typecheck
npm test
npm run build
php artisan p:extension:doctor /path/to/announcements
php artisan p:extension:pack /path/to/announcements

Uninstall

Remove it under Admin → Extensions, or from a terminal:

php artisan p:extension:remove announcements

License

MIT. See LICENSE.

This is a community extension and is not affiliated with or endorsed by Pterodactyl.

About

Show scheduled announcements to everyone, or only to servers on chosen nodes, locations or eggs.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages