Configuration

NReport is a versatile plugin that can operate on a single server as well as a network of interconnected servers (like Velocity or BungeeCord). Below are the detailed steps to configure the plugin for each of these scenarios.

Choose the mode that best fits your server's structure.

Option 1: Single Server Mode (Standalone)

This is the simplest and quickest setup. It's ideal if you only have one Minecraft server and do not use a proxy to connect multiple servers.

Requirements

• The NReport.jar file.

Configuration Steps

1. Install the Plugin: Place the NReport.jar file into the plugins folder of your Spigot/Paper server.

2. Start the Server: Start your server once to generate the NReport folder with all its configuration files.

3. Configure config.yml: Open the plugins/NReport/config.yml file and ensure these two options are set as follows:

   # plugins/NReport/config.yml
   # ... other options ...
   
   # --- Storage Configuration ---
   storage:
     # For a single server, YAML is sufficient and requires no extra setup.
     type: YAML
   
   # ... other options ...
   
   # --- Network Configuration ---
   # Set to 'false' if this is a single server.
   network-mode: false

4. Restart or Reload: Restart your server or run the command /nreport reload to apply the changes.

How does it work in this mode?

• Local: All notifications, reports, and actions are managed solely within this server.

• Storage: Data is saved in the reports.yml and warnings.yml files inside the plugin's folder.

• Limitations: You will not be able to see reports from other servers or teleport to players who are not on this same instance.

Option 2: Network Mode (with NStaff-Proxy)

This is the advanced and recommended setup for server networks using a proxy like Velocity. It allows for centralized and seamless moderation across all your servers.

Requirements

• The NReport.jar file.

• The NStaff-Proxy.jar file. (https://modrinth.com/plugin/nstaff-proxy)

• A MySQL database accessible from all your servers.

Configuration Steps

1. Install NStaff-Proxy: Place the NStaff-Proxy.jar file into the plugins folder of your Velocity proxy.

2. Install NReport: Place the NReport.jar file into the plugins folder of EACH of your Spigot/Paper servers (Lobby, Survival, Skywars, etc.).

3. Start Everything: Start your proxy and all your servers once to generate the necessary folders and configuration files.

4. Configure config.yml on EACH Spigot/Paper server: Open the plugins/NReport/config.yml file on each of your servers and adjust it as follows:

   # plugins/NReport/config.yml
   
   # Assign a UNIQUE name to each server. This is crucial.
   # Example on the Lobby server:
   server-name: "Lobby"
   # Example on the Survival server:
   # server-name: "Survival"
   
   # --- Storage Configuration ---
   storage:
     # MYSQL is REQUIRED for network mode.
     type: MYSQL
     # Fill in your database details.
     mysql:
       host: "localhost" # Or your database IP
       port: 3306
       database: "nreport_db" # Your database name
       username: "user"       # Your MySQL username
       password: "password"   # Your MySQL password
       useSSL: false
   
   # --- Network Configuration ---
   # Set to 'true' to enable communication with NStaff-Proxy.
   network-mode: true

5. Restart the Network: Completely restart your proxy and all Spigot/Paper servers to ensure the database connection and inter-plugin communication are established correctly.

How does it work in this mode?

• Global and Synchronized: Thanks to NStaff-Proxy and MySQL, all your servers share the same information.

• Global Notifications: A report created on any server will notify all staff connected across the network.

• Smart Teleport: If a staff member is in the Lobby and teleports to a player in Survival, the plugin will automatically move them to the correct server and location.

• Accurate Connection Status: The plugin knows if a player is online on any server within the network.