CraftersStaff

CraftersStaff is designed to work standalone on a single server, or synchronized across an entire network using shared databases (MySQL) and Proxy messaging.

For single servers (Spigot/Paper)

1. Download the latest version of CraftersStaff.jar.
2. Place the file inside your server's plugins/ folder.
3. Start the server to generate the plugins/CraftersStaff/ configuration folder.
4. By default, the plugin uses an embedded local database (H2). It is ready to use!

For networks (Velocity / BungeeCord)

1. Place CraftersStaff.jar in the plugins/ folder of all your backend servers (Spigot/Paper).
2. Optionally, place it in your Proxy (Velocity/BungeeCord) to enable network-wide alerts (Global Staff Chat).
3. In the config.yml file of each backend server, configure your MySQL credentials. Make sure all servers point to the same database.
4. Set bungee-mode: true or velocity-mode: true accordingly.
5. Restart your network.

1. Staff Mode & Vanish

By executing /staff, the moderator's inventory, XP level, health, and position are safely saved to the database. The player enters creative mode, receives interactive moderation items in their hotbar, and automatically enters Vanish.

The Vanish system hides the staff member from the TabList, the visual world, and commands from other plugins, guaranteeing truly silent investigations.

2. Freeze System

Allows you to immobilize a suspicious player using /freeze <player>. During this state:

• The player cannot move, attack, chat publicly, drop items, or execute unauthorized commands.
• A FreezerChat opens automatically: a private, direct channel between the player and the staff team to request AnyDesk/Discord screenshares.
• If the player attempts to evade by disconnecting, the staff team receives a critical network-wide alert.

3. Notes and Reports

Notes: Administrators can add notes to a player's history using /notes. Notes support tracking statuses (PENDING, IN_PROGRESS, RESOLVED), allowing the team to manage long-term disciplinary cases.

Reports: When a user executes /report, the case is sent to a centralized GUI (/reports). Moderators can "claim" the report (to prevent two staff members from handling the same issue), teleport to the scene, or archive it with a click.

All commands and actions are protected by granular permissions so you can assign exact hierarchies (e.g., Helper, Mod, Admin).

The configuration is designed to be intuitive and predictable. Here is a glimpse of the key options available in the plugin's core:

# Global CraftersStaff Configuration
database:
  type: H2 # Options: H2, MYSQL
  mysql:
    host: "localhost"
    port: 3306
    database: "server_db"
    user: "root"
    password: ""

staff-mode:
  # Should staff automatically enter Vanish when enabling Staff Mode?
  auto-vanish: true
  # Saves inventory to the database to prevent absolute loss
  secure-inventory-save: true
  
freeze:
  # Commands that a frozen player IS allowed to execute
  allowed-commands:
    - "/msg"
    - "/r"
    - "/helpop"
  
network:
  # Enable support for proxy networks
  bungee-mode: false
  # Synchronize Staff Chat between servers connected to the same DB
  sync-staffchat: true

All of the plugin's graphical interfaces (Reports, Notes, Player Inspector) are customizable from menus.yml, allowing you to adapt icons, positions, and descriptions to your network's liking.

CraftersStaff provides a robust API for developers to interact with the Staff Mode, Vanish, and Freeze systems. You can access the API statically through the CraftersStaffAPI class.

Maven Repository

<repository>
    <id>crafters-repo</id>
    <url>https://repo.craftersdevelopment.net/releases</url>
</repository>

<dependency>
    <groupId>net.craftersdevelopment</groupId>
    <artifactId>CraftersStaff-API</artifactId>
    <version>8.5.9</version>
    <scope>provided</scope>
</dependency>

API Examples

Here are some common examples of how to utilize the API within your own plugins.

import com.craftersstaff.api.CraftersStaffAPI;
import org.bukkit.entity.Player;

public class StaffHook {

    // Check if a player is currently in Staff Mode
    public boolean isStaffMode(Player player) {
        return CraftersStaffAPI.isStaffMode(player.getUniqueId());
    }

    // Check if a player is currently Vanished
    public boolean isVanished(Player player) {
        return CraftersStaffAPI.isVanished(player.getUniqueId());
    }

    // Check if a player is currently Frozen
    public boolean isFrozen(Player player) {
        return CraftersStaffAPI.isFrozen(player.getUniqueId());
    }

    // Broadcast a network-wide alert to all staff members
    public void alertStaff(String message) {
        CraftersStaffAPI.sendNetworkAlert(message);
    }
}

Events

You can also listen to custom events such as StaffModeChangeEvent, StaffVanishEvent, PlayerFreezeEvent, and PlayerUnfreezeEvent.

import com.craftersstaff.api.events.StaffModeChangeEvent;

@EventHandler
public void onStaffMode(StaffModeChangeEvent event) {
    Player player = event.getPlayer();
    if (event.isEnteringStaffMode()) {
        player.sendMessage("You entered Staff Mode!");
    } else {
        player.sendMessage("You left Staff Mode!");
    }
}