> For the complete documentation index, see [llms.txt](https://docs.mipcraft.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mipcraft.eu/network-manager/faq.md).

# FAQ

## General & Architecture

<details>

<summary>What proxy software is supported?</summary>

NetworkManager supports both **Velocity 3.x** (recommended for performance and safety) and **BungeeCord** (legacy support). Features are fully mirrored across both platforms.

</details>

<details>

<summary>Does this work with Spigot/Paper servers?</summary>

Yes. NetworkManager operates as a dual-role plugin:

1. It runs on the proxy as the coordinator and API server.
2. It runs on backend Spigot/Paper servers using the **same JAR** to handle local features like in-game navigation menus, PlaceholderAPI values, and clean reboot commands. They communicate using the `nm:channel` plugin channel.

</details>

## Database & DataManager Prerequisite

<details>

<summary>Why do I need the DataManager plugin?</summary>

NetworkManager relies on the **DataManager** plugin to establish a centralized MySQL/MariaDB database connection pool. This architecture separates database pooling logic from network logic, ensuring higher stability and avoiding connection leaks.

</details>

<details>

<summary>What tables does NetworkManager create in the database?</summary>

NetworkManager automatically initializes two tables upon startup:

* `NetworkManagerPD` — Player data (UUID, username, playtime, first/last connection times).
* `NetworkManagerBans` — Ban logs (UUID, username, expiration date, reason, IP address, and ban counts).

</details>

## Friend & Party Manager Integrations

<details>

<summary>How does the dashboard show Friend lists?</summary>

NetworkManager includes a **FriendPartyBridge** that automatically checks if the database table `FriendsManagerRelationsPD` is present. If detected:

1. The backend automatically reads player friendship networks.
2. The web panel displays a **Friends Tab** in the player's detail profile, showing their friends and the date they became friends.

</details>

<details>

<summary>How does the Party Manager integration work?</summary>

The dashboard queries the proxy's active party registry. If a compatible Party Management plugin is configured, administrators can view active party sizes, leaders, and members on the Player Detail page or via `/api/parties`.

</details>

<details>

<summary>Can I moderate parties or add friends directly from the web panel?</summary>

Currently, the Friend and Party integrations are read-only. They allow administrators to inspect friendships and party associations for investigative or moderate purposes (e.g. tracking ban evasions or grouping griefers).

</details>

## Web Dashboard & Security

<details>

<summary>What is the `api_key` in `config.yml`?</summary>

NetworkManager automatically generates a secure 32-character API key on first startup. You can use this key instead of your main password when connecting remote dashboards or creating custom scripts that query the REST API. Simply send the token in the headers as:

`Authorization: Bearer <your_api_key_here>`

</details>

<details>

<summary>Can I run the dashboard behind Nginx with SSL/HTTPS?</summary>

Yes. It is highly recommended to use a reverse proxy like Nginx to handle SSL termination. Point Nginx to serve the dashboard's static folder and proxy `/api/*` requests to the proxy's internal bind port (e.g., `8080`).

</details>

## MOTD & Customization

<details>

<summary>How do I use hex colors in the MOTD?</summary>

Use the `#RRGGBB` format directly in your MOTD text:

```
Welcome to #FF6B35MyNetwork #6366F1✦
```

The web dashboard features a live preview rendering these hex colors exactly as they will appear in the Minecraft multiplayer server list.

</details>

<details>

<summary>Can I customize the look of in-game GUI menus?</summary>

Yes. Open `plugins/NetworkManager/config.yml` on your backend Spigot/Paper servers to customize item materials, lore lines, and display titles for `/games`, `/hubs`, and `/ban` menus.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.mipcraft.eu/network-manager/faq.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
