# 📜 MOTD

It can handle rotating MOTDs, hover text, server icons, fake player counts, and max player count controls.

***

### What It Does

The MOTD module controls how your Velocity network appears in the Minecraft multiplayer server list.

It can be used to configure:

* Server MOTD lines
* MOTD rotation
* Hover player list
* Server list icons
* Fake online player count
* Max player count
* Ping response customization

***

### When To Enable It

Enable this module if you want NexusProxy to control your network MOTD from the proxy.

This module is useful if you want:

* A custom server list appearance
* Rotating MOTD messages
* Seasonal or event MOTDs
* Custom hover text
* Custom server icons
* Fake or adjusted online player counts
* Controlled max player display

***

### Requirements

The MOTD module does not require external dependencies.

| Dependency     | Required | Purpose       |
| -------------- | -------- | ------------- |
| Redis          | No       | Not required. |
| MySQL          | No       | Not required. |
| MongoDB        | No       | Not required. |
| PacketEvents   | No       | Not required. |
| Discord        | No       | Not required. |
| PlaceholderAPI | No       | Not required. |

{% hint style="info" %}
The MOTD module works through Velocity proxy ping handling.
{% endhint %}

***

### Configuration File

The MOTD module configuration file is located at:

```
plugins/NexusProxy/modules/motd/motd.yml
```

This file can contain settings for:

* Module status
* MOTD lines
* MOTD rotation
* Hover list
* Server icons
* Fake player count
* Max player count
* Ping response behavior
* Messages and formatting

***

### Default Commands

The MOTD module does not provide default player commands in the shipped command list.

It is mainly configured through:

```
plugins/NexusProxy/modules/motd/motd.yml
```

***

### Permissions

The MOTD module does not provide default player permissions in the shipped permission list.

Access is controlled by editing the module configuration file.

***

### MOTD Lines

The MOTD is the text shown under your server name in the Minecraft multiplayer server list.

A typical MOTD uses two lines.

Example:

```yaml
motds:
  default:
    line1: "&6&lNexus Network"
    line2: "&fSurvival, Events, Friends & More"
```

{% hint style="info" %}
Formatting depends on how your module configuration handles colors and text components.
{% endhint %}

***

### MOTD Rotation

MOTD rotation allows the server list message to change automatically.

This is useful for:

* Promoting events
* Showing updates
* Advertising sales
* Displaying seasonal messages
* Making the server list look more dynamic

Example concept:

```yaml
rotation:
  enabled: true
  interval: 5
```

Then configure multiple MOTDs in the module file.

***

### Hover List

The hover list is the player sample shown when a player hovers over the online count in the multiplayer server list.

This can be used to show:

* Network information
* Website link
* Store link
* Discord link
* Current event
* Staff message

Example concept:

```yaml
hover:
  - "&6Nexus Network"
  - "&fplay.example.net"
  - "&7Join our Discord!"
```

***

### Server Icons

The MOTD module can control server icons shown in the Minecraft server list.

This is useful for:

* Branding
* Seasonal icons
* Event icons
* Maintenance icons

{% hint style="warning" %}
Make sure your icon files match Minecraft server icon requirements.

Incorrect icon size or format may prevent the icon from displaying correctly.
{% endhint %}

***

### Fake Player Count

The MOTD module can control fake or adjusted player counts, depending on configuration.

This can be used to customize how the online count appears in the server list.

Example use cases:

* Displaying a boosted online count
* Showing a custom online value
* Adjusting the visible player count for branding

{% hint style="warning" %}
Use fake player count features carefully.

Misleading player counts can create distrust if overused.
{% endhint %}

***

### Max Player Count

The max player count controls the maximum player number shown in the multiplayer server list.

Example:

```yaml
max_players: 500
```

This does not necessarily mean your network can safely support that number of players.

It only controls what is displayed in the server list, depending on your configuration.

***

### Common Use Cases

#### Normal network MOTD

Use a clean MOTD for general branding.

```yaml
line1: "&6&lNexus Network"
line2: "&fA modern Minecraft network"
```

***

#### Event MOTD

Use rotation or a temporary MOTD for events.

```yaml
line1: "&d&lWeekend Event"
line2: "&fJoin now for special rewards!"
```

***

#### Maintenance MOTD

If your network is under maintenance, you can show a maintenance-style MOTD.

```yaml
line1: "&c&lMaintenance"
line2: "&7We will be back soon."
```

{% hint style="info" %}
If you use the Maintenance module, check its MOTD options too.

Maintenance-specific MOTD behavior may be configured in the Maintenance module.
{% endhint %}

***

### Setup Tips

* Keep MOTD lines short and readable.
* Use MOTD rotation for events, updates, or promotions.
* Use hover text to show useful links or network information.
* Make sure server icons use the correct size and format.
* Do not overuse fake player count features.
* Test the MOTD from a Minecraft client after every major change.
* Restart or reload NexusProxy after editing the module configuration.
* Check `motd.yml` if the MOTD does not appear as expected.

***

### Common Issues

#### MOTD does not change

Check that:

* The MOTD module is enabled.
* The configuration file was saved correctly.
* NexusProxy was restarted or reloaded.
* Another plugin is not overriding the proxy ping response.
* The player refreshed the multiplayer server list.

***

#### Server icon does not show

Check that:

* The icon file exists.
* The file path is correct.
* The image format is supported.
* The image size matches Minecraft server icon requirements.
* The module configuration points to the correct icon.

***

#### Hover list does not show correctly

Check that:

* Hover list entries are configured correctly.
* Formatting codes are valid.
* The module is enabled.
* Another plugin is not modifying the same ping response.

***

#### Fake player count is incorrect

Check that:

* Fake player count is enabled only if you want it.
* The configured value or formula is correct.
* Another plugin is not changing the player count.
* The MOTD module is handling the proxy ping response.

***

#### Max player count is wrong

Check that:

* The max player count option is configured correctly.
* NexusProxy was reloaded or restarted.
* Another plugin is not overriding the ping response.

***

### Summary

The MOTD module controls how your network appears in the Minecraft server list.

It is recommended if you want NexusProxy to manage MOTD lines, rotation, hover list, icons, fake player counts, and max player count display from the proxy.


---

# 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/modules/motd.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.