> 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/velocitystaffalerts/information.md).

# Information

## :exclamation: Introduction

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

## :book: Overview

**VelocityStaffAlerts** 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 Velocity version 1.21 or higher.
* This plugin requires LuckPerms.

### Steps

1. **Download the VelocityStaffAlerts Plugin jar** from (Coming Soon..).
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                                              |
| ------------ | -------------------------------------------------------- |
| "vsa.staff"  | Permission to flag the alerts. (Give this to your staff) |
| "vsa.notify" | Permission to receive alerts in game                     |

## :man\_technologist: Configuration

After installation, a `config.yml` file will be generated in the `plugins/VelocityStaffAlerts` 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
# VelocityStaffAlerts Configuration

Use-Webhook: true
Webhook-URL: "<DISCORD WEBHOOK URL>"

#Minecraft Messages
#Placeholders: %player% | %serverto% | %serverfrom%
staff-join: "[VSA] %prefix%%player% &fhas connected to the server."
staff-leave: "[VSA] %prefix%%player% &fhas disconnected from the server."
staff-switch: "[VSA] %prefix%%player% &fconnected to &b%server% &ffrom &b%from_server%&f."

#Discord Webhook Messages:
#Placeholders: %player% | %serverto% | %serverfrom%
staff-join-discord: "[VSA] %player% has connected to the server."
staff-leave-discord: "[VSA] %player% has disconnected from the server."
staff-switch-discord: "[VSA] %player% connected to %serverto% from %serverfrom%"

```