Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.
« Return to Documentation Home Page // Player Info Module

Player Info Module

Introduction

The Player Info module displays basic information about players on the server.

Listing all players

Nucleus provides an enhanced version of the /list command that can be customised. In main.conf, if playerinfo.list.group-by-permission-groups is set to true, Nucleus will use the nucleus.list.group permission meta/option to determine the name of the group they player should be displayed in.

For example, if players in the "mod" group should be displayed in a "Mod" group where the colour of the group is light blue, set the `nucleus.list.group` option to `&bMod`. A sample command is:

Loading...

If the nucleus.list.group option is unset or empty, the text in playerinfo.list.default-group-name will be used as the group name in the /list.

If you are running Multicraft, set multicraft-compatibility to true. This should send the original /list command to the console when it is run from the console.

If you want a bit more control over your groups, then Nucleus allows for that too.

Group ordering

The group ordering can be defined in main.conf, playerinfo.list.list-grouping-by-permission.group-order. Groups can be listed in order here, and this will be reflected in /list. Note that you must keep the [], and it’s a comma separated list, where the names are enclosed in “ characters.

Any group aliases in this list will be listed in this order, above all other groups, which will be displayed in alphabetical order below.

Using /seen

/seen [player] will display all relevant information about a player. In the future, it is anticipated that plugins can hook into Nucleus’ /seen, allowing this command to be a central point for player information.

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

No plugin incompatibilities have been reported.

/getfromip
Module: playerinfo
Gets all users last seen on the specified IP.

Aliases: /getfromip

Usage: /getfromip <IP Address>

Default Role: admin

Basic Command Permission: nucleus.getfromip.base

Permissions

  • nucleus.getfromip.base - Default Role: admin
    Allows the user to run the command /getfromip
/getpos
Module: playerinfo
Gets the location of the executing or target player.

Aliases: /getpos, /coords, /position, /whereami, /getlocation, /getloc

Usage: /getpos [<user>]

Default Role: user

Basic Command Permission: nucleus.getpos.base

Permissions

  • nucleus.getpos.exempt.cost - Default Role: admin
    Allows the user to bypass the cost for /getpos
  • nucleus.getpos.base - Default Role: user
    Allows the user to run the command /getpos
  • nucleus.getpos.exempt.cooldown - Default Role: admin
    Allows the user to bypass the cooldown for /getpos
  • nucleus.getpos.exempt.warmup - Default Role: admin
    Allows the user to bypass the warmup for /getpos
  • nucleus.getpos.others - Default Role: staff
    Allows the user to view the position of other players.
/list
Module: playerinfo
Lists the players on the server.

Aliases: /list, /listplayers, /ls

Usage: /list

Default Role: user

Basic Command Permission: nucleus.list.base

Permissions

  • nucleus.list.exempt.cooldown - Default Role: admin
    Allows the user to bypass the cooldown for /list
  • nucleus.list.base - Default Role: user
    Allows the user to run the command /list
  • nucleus.list.seevanished - Default Role: admin
    Allows the user to see vanished players in /list.
  • nucleus.list.exempt.cost - Default Role: admin
    Allows the user to bypass the cost for /list
  • nucleus.list.exempt.warmup - Default Role: admin
    Allows the user to bypass the warmup for /list

This command is an equivalent to the following command(s) in Essentials: /list, /who, /playerlist, /online, /plist

/near
Module: playerinfo
List players nearby

Aliases: /near

Usage: /near [<user>] [<radius>]

Default Role: user

Basic Command Permission: nucleus.near.base

Permissions

  • nucleus.near.exempt.cost - Default Role: admin
    Allows the user to bypass the cost for /near
  • nucleus.near.base - Default Role: user
    Allows the user to run the command /near
  • nucleus.near.exempt.warmup - Default Role: admin
    Allows the user to bypass the warmup for /near
  • nucleus.near.exempt.cooldown - Default Role: admin
    Allows the user to bypass the cooldown for /near

This command is an equivalent to the following command(s) in Essentials: /near

/seen
Module: playerinfo
Gets information about the specified player.

Aliases: /seen, /seenplayer, /lookup

Usage: /seen <user uuid>|<user>

Default Role: admin

Basic Command Permission: nucleus.seen.base

Permissions

  • nucleus.seen.base - Default Role: admin
    Allows the user to run the command /seen
  • nucleus.seen.extended.flying.canfly - Default Role: admin
    Allows the executor to see if the player can fly by double jumping.
  • nucleus.seen.extended.speed.walking - Default Role: admin
    Allows the executor to see the current walking speed of the player.
  • nucleus.seen.extended.location - Default Role: admin
    Allows the executor to see the player's current location.
  • nucleus.seen.extended.speed.flying - Default Role: admin
    Allows the executor to see the current flying speed of the player.
  • nucleus.seen.extended.lastplayed - Default Role: admin
    Allows the executor to see the date when the player was last on the server.
  • nucleus.seen.extended.flying.isflying - Default Role: admin
    Allows the executor to see if the player is flying.
  • nucleus.seen.extended.uuid - Default Role: admin
    Allows the executor to see the player's UUID.
  • nucleus.seen.extended.firstplayed - Default Role: admin
    Allows the executor to see when the player first joined the server.
  • nucleus.seen.extended.gamemode - Default Role: admin
    Allows the executor to see the player's current game mode.
  • nucleus.seen.extended.ip - Default Role: admin
    Allows the executor to see the player's IP.

This command is an equivalent to the following command(s) in Essentials: /seen

Permission Suggested Role Description
nucleus.getfromip.base admin Allows the user to run the command /getfromip
nucleus.getpos.base user Allows the user to run the command /getpos
nucleus.getpos.exempt.cooldown admin Allows the user to bypass the cooldown for /getpos
nucleus.getpos.exempt.cost admin Allows the user to bypass the cost for /getpos
nucleus.getpos.exempt.warmup admin Allows the user to bypass the warmup for /getpos
nucleus.getpos.others staff Allows the user to view the position of other players.
nucleus.list.base user Allows the user to run the command /list
nucleus.list.exempt.cooldown admin Allows the user to bypass the cooldown for /list
nucleus.list.exempt.cost admin Allows the user to bypass the cost for /list
nucleus.list.exempt.warmup admin Allows the user to bypass the warmup for /list
nucleus.list.seevanished admin Allows the user to see vanished players in /list.
nucleus.near.base user Allows the user to run the command /near
nucleus.near.exempt.cooldown admin Allows the user to bypass the cooldown for /near
nucleus.near.exempt.cost admin Allows the user to bypass the cost for /near
nucleus.near.exempt.maxradius admin Allows the user to bypass the maximum radius check
nucleus.near.exempt.warmup admin Allows the user to bypass the warmup for /near
nucleus.near.others user Allows the user to target other players using the command "near".
nucleus.seen.base admin Allows the user to run the command /seen
nucleus.seen.extended.firstplayed admin Allows the executor to see when the player first joined the server.
nucleus.seen.extended.flying.canfly admin Allows the executor to see if the player can fly by double jumping.
nucleus.seen.extended.flying.isflying admin Allows the executor to see if the player is flying.
nucleus.seen.extended.gamemode admin Allows the executor to see the player's current game mode.
nucleus.seen.extended.ip admin Allows the executor to see the player's IP.
nucleus.seen.extended.lastplayed admin Allows the executor to see the date when the player was last on the server.
nucleus.seen.extended.location admin Allows the executor to see the player's current location.
nucleus.seen.extended.speed.flying admin Allows the executor to see the current flying speed of the player.
nucleus.seen.extended.speed.walking admin Allows the executor to see the current walking speed of the player.
nucleus.seen.extended.uuid admin Allows the executor to see the player's UUID.
The following configuration is the default for this module:
                            list {
    # If true, /list will be displayed in a compact form.
    compact-list=true
    # If compact /list is enabled, this specifies how many players will be sent in one line. If clients are disconnecting when running list, lower the number.
    compact-max-players=20
    list-grouping-by-permission {
        # If listing by groups is enabled, the group name to display when a player is not in a group.
        default-group-name=Default
        # If enabled, list players by their groups.
        enabled=false
        # Any group aliases in this list will be listed in this order, above all other groups, which will be displayed in alphabetical order below.
        group-order=[]
    }
    # Enable this if you are using a server panel, such as Multicraft or PterodactylPanel. This will run /minecraft:list when /list is run on the console.
    server-panel-compatibility=false
    # The template to use to display a player's name. Uses the same tokens as chat. Defaults to "{{displayname}}".
    template="{{displayname}}"
}
near {
    # The max radius for the /near command, bypassable with the permission "nucleus.near.maxexempt".
    max-radius=200
}
seen {
    # If true, the permission "nucleus.seen.extended" is required for all information that comes from modules. If false, information will be displayed based on the command permissions a player has (so, a player with check ban rights can see banning information).
    require-extended-permission-for-module-info=false
}

                        
Search

Downloading search database, this won't take long...