Configuring MonServer

Configuring MonServer for its use

Please Note

The mod warns the users that you are overwriting its settings in any way

After installing to your Paper/Spigot/Fabric Server and rebooted your server, when you join the server with the mod enabled, a message like this would appear from your client

This means it is already working, that message from the client means that i got what it should be showing on the status of the profile, and by default the config should generate like this

Paper/Spigot

Generated in /plugins/MonServer/config.yml

# WARNING: Changing ANY of these settings will modify the discord status shown to players
# Doing so may make people's status not available to use when they are on your server
# But this also WILL alert the users when they join that you are changing these settings
settings:
  # The Custom Application ID
  # This sets the Discord Application ID that players will use specifically when they connect to your server.
  #
  # To get one:
  # 1. Go to https://discord.com/developers/applications
  # 2. Create a "New Application"
  # 3. Copy the "Application ID" and paste it below
  #
  # If this value is left blank (""), the client will use either the mod's built-in default ID
  # or the custom ID the player has manually set in their own mod config.
  #
  # Default: "" (Blank to usually prevent any errors)
  discord-client-id: ""


  # Details and State 
  # These settings below define the text shown in the player's Discord Rich Presence
  # below the application's title, so when players join your server, instead of showing
  # generic text like "Playing <Server> (Multiplayer)", "<IP Address>", you can
  # edit it to reflect your branding, something like "Playing on My Awesome Server" or
  # "Online: 5/20 players", this works with PlaceholderAPI to show dynamic values

  # Details
  # This defines the text appearing below the application name, this can give examples of "Playing on Server Name"
  details: "Playing on Server Name"

  # State
  # This defines the text appearing below the details, this can give examples of "Online: 5/20"
  state: "Online: %server_online%/%server_max_players%"

  # Privacy Settings

  # If true, this hides the actual Server IP/Address in the player's status.
  # This is useful for protecting server privacy and preventing accidental exposure
  # of private server details in public profiles.
  hide-ip: false

  # If true, this hides the detected Server Name (from the server list of the client).
  # If enabled, the default status will show as "Playing Multiplayer" unless you override
  # it with the 'details' setting above. This is useful when you want to keep the server name
  # private but still show the player’s activity.
  hide-server-name: false

Fabric

Any of these settings made here and reloading it with /mon reload (with permissions) will reflect the players status, what you can change may differ by version of the addon and the parent mod

Setting up a Custom Discord ID

You can use a custom ID to use on the status instead of the ones used by the built-in mod or from players' configuration files

To do so, go to the Discord Developer Portal and click on "New Application", the name is what it should be in the status so choose carefully

After creating the application

When the Application is made, simply copy its App ID, ensuring you disable to be invited to any server by any sort of means, as it works only for the status

To ensure it is disabled for being invited to any servers, change the following things:

1. On the "Installation" tab disable "User Install" and set the "Install Link" to "None"

2. Then go to the "Bot" tab and disable "Public bot"

Finally you can copy the ID and paste it to your config file

App ID Error

When the client connects to the server and sees that the Application ID seems invalid, the client will silently revert back to use either the ID bundled by the mod, or from what the player has set

If you see this message in particular:

This means that your application ID seems to be invalid, simply update it with a valid ID from the Developer Portal

Configuring the text

Normally the plugin generates this to the status of your profile

If you by some reason see %server_online%/%server_max_players% instead of the server count on your status that means PlaceholderAPI is not installed and the placeholder for the server variables has not been downloaded

After downloading PlaceholderAPI ensure you do this:

1. Run /papi ecloud download Server and /papi reload when it is done

2. Reconnect to your server to see its changes as it does not do a constant-update

You have 2 ways of configuring the text:

1. details is used to show what should be showing instead of "Playing <Server Name> (Multiplayer)" below the App ID's title

2. state is used to show what should be showing instead of "<IP>" at the right of the game time

For SMPs

Please note

1. To be able to hide the Server Name and IP extracted from the clients, you must leave details and state left empty to be able to work

2. Any player can easily turn the Server Name and IP off by setting multiplayerShowIp and multiplayerShowName to false, or that Privacy Mode (privacyMode) is turned on in the mod's settings

If you are a SMP owner and you suspect someone with Minecraft On Discord, if your SMP is private and DO not want to leak the IP or name, you can turn on hide-ip and hide-server-name to hide from the user and any future user to prevent leaking any info, understanding the notes above