> For the complete documentation index, see [llms.txt](https://docs.pixel-dev.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pixel-dev.net/bungeestaffalerts/information.md).

# Information

## :exclamation: Introduction

Welcome to the **BungeeStaffAlerts** documentation! This plugin is designed to keep server administrators and staff informed of staff activity across a BungeeCord network. Whether staff members join, leave, or switch servers, BungeeStaffAlerts ensures you are always in the know, both in-game and on Discord.

## :book: Overview

**BungeeStaffAlerts** is a lightweight plugin that sends real-time alerts to staff when other staff members connect, disconnect, or switch between servers. It integrates seamlessly with Discord via a custom webhook, providing a unified communication channel for all your server needs.

## :star: Features

* 🔔 **Real-Time In-Game Alerts**: Automatically notify staff in-game of other staff members' activities.
* 🌐 **Discord Webhook Integration**: Send activity alerts directly to a Discord channel.
* ⚡ **Lightweight and Efficient**: Designed to have minimal impact on server performance.
* 🛠️ **Easy to Configure**: Simple setup process with clear instructions.

## :inbox\_tray: Installation

### Prerequisites

* Minecraft server running Bungeecord version 1.21 or higher.

### Steps

1. **Download the BungeeStaffAlerts Plugin jar** from [BuiltByBit](https://builtbybit.com/resources/bungeestaffalerts.51106/).
2. **Place the jar file** into your server's 'plugins' directory.
3. **Restart your server** to load the plugin.

## :wrench: Commands & Permissions

### Permissions

| Permission   | Description                                              |
| ------------ | -------------------------------------------------------- |
| "bsa.staff"  | Permission to flag the alerts. (Give this to your staff) |
| "bsa.notify" | Permission to receive alerts in game                     |

## :man\_technologist: Configuration

After installation, a `config.yml` file will be generated in the `plugins/BungeeStaffAlerts` directory. This file allows you to customize various settings, including the Discord webhook URL and message formats.

#### Basic Configuration

Below is what the `config.yml` file looks like:

```yaml
# BungeeStaffAlerts Configuration

Use-Webhook: 'true'
Webhook-URL: <WEBHOOK URL HERE>

#Minecraft Messages
#Placeholders: %player% | %serverto% | %serverfrom%
ConnectedMessage: '&f&lBSA > &6%player% &fhas connected to the server.'
DisconnectMessage: '&f&lBSA > &6%player% &fhas disconnected from the server.'
TransferMessage: '&f&lBSA > &6%player% &fconnected to &b%serverto% &ffrom &b%serverfrom%&f.'

#Discord Webhook Messages:
#Placeholders: %player% | %serverto% | %serverfrom%
DiscordConnectedMessage: '[BSA] %player% has connected to the server.'
DiscordDisconnectMessage: '[BSA] %player% has disconnected from the server.'
DiscordTransferMessage: '[BSA] %player% connected to %serverto% from %serverfrom%.'

```