# 🚀 Introduction

NexusProxy is designed for Minecraft networks that want powerful proxy features without having to install and maintain many separate plugins.

***

### What is NexusProxy?

NexusProxy is a Velocity proxy plugin built to manage common network systems from one place.

Instead of using multiple separate plugins for messaging, staff tools, maintenance, MOTD, friends, reports, queues, and other proxy features, NexusProxy provides these systems through independent modules.

Each module can be configured, enabled, disabled, and customized depending on what your network needs.

***

### Main Features

NexusProxy includes:

* Proxy command suite
* Private messages, replies, ignore system, social spy, and message toggle
* Lobby and multi-lobby routing
* Staff, admin, and donor chats
* Staff list and staff AFK system
* Maintenance mode with countdowns, whitelists, scopes, MOTD changes, and icons
* MOTD manager with rotation, hover list, icons, fake player count, and max player count controls
* Automatic and manual announcements
* Donation broadcasts
* Friends system
* HelpOp ticket system
* Player report system
* Queue system
* Ping command and ping placeholders
* Proxy-side placeholder parser
* Tab completion filtering
* Optional PacketEvents support
* Optional Redis synchronization
* Optional MySQL or MongoDB storage
* Optional Discord webhook and bot integrations
* Optional PlaceholderAPI expansion for backend lobby servers
* Public Java API for developers

***

### Modular System

NexusProxy is module-based.

Each feature has its own configuration file inside:

```
plugins/NexusProxy/modules/<module>/<module>.yml
```

This allows you to enable only the systems you need.

For example, you can enable the Messaging module without enabling Friends, or enable Maintenance without using Donations.

{% hint style="info" %}
Most modules can be enabled or disabled individually from their own module configuration file.
{% endhint %}

***

### Built for Velocity Networks

NexusProxy must be installed on the Velocity proxy.

It should not be installed on backend Paper, Spigot, or Purpur servers.

Backend servers are only used for optional integrations, such as the PlaceholderAPI expansion.

{% hint style="warning" %}
Install the main NexusProxy plugin only on your Velocity proxy.
{% endhint %}

***

### Multi-Proxy Support

NexusProxy can use Redis to synchronize data across multiple Velocity proxies.

Redis is recommended if your network has more than one proxy or needs shared information between proxies.

Redis can be used for:

* Global online counts
* Proxy online counts
* Server online counts
* Cross-proxy player presence
* Friends online status
* Staff synchronization
* Synced announcements
* Synced donation broadcasts

***

### Persistent Storage

NexusProxy supports optional database storage through MySQL or MongoDB.

Database storage is recommended for systems that need persistent data, such as:

* Friends
* Known player profiles
* Ignored players
* Private message data
* HelpOp history
* Other history-backed features

If you do not need persistent storage, NexusProxy can also run in memory-only mode depending on your setup.

***

### Useful Links

* [NexusProxy on BuiltByBit](https://builtbybit.com/resources/nexusproxy-all-in-one-core-velocity.98899/)
* [PacketEvents on Modrinth](https://modrinth.com/plugin/packetevents)
* [PlaceholderAPI on Modrinth](https://modrinth.com/plugin/placeholderapi)
* [Discord Support](https://discord.gg/WHBWBWWYDq)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://nexusproxy.nemesismc.net/getting-started/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.