Essential

The Essential module provides a bunch of various, common utility commands and features.


Broadcast

Sets up how your server-wide broadcast messages look in the chat. You can add prefixes, borders, or colors to make the announcements pop out.

Broadcast:
  # Text Formations: https://nightexpressdev.com/nightcore/configuration/text-formation/
  Format:
  - ''
  - <yellow><b>BROADCAST:</b></yellow>
  - ''
  - <gray>%message%</gray>
  - ''

Disposal

Configures the portable trash can menu. You can easily change the window title and how many inventory slots it has.

Disposal:
  Title: <black>Disposal</black>
  InventorySize: 36

Invulnerability

Controls how the god mode command works for your players. You can decide if invincible players are still allowed to punch mobs or fight other players. You can also make it freeze their food and oxygen levels so they don't starve or drown.

Invulnerability:
  # Controls whether the Invulnerability feature is available to use.
  # [*] Note: The Invulnerability feature uses vanilla 'invulnerable' NBT tag. Ensure that no other plugins depends on that tag to avoid possible conflicts/issues.
  Enabled: true
  # List of worlds where the Invulnerability is disabled.
  # [*] Note: It will reset player's 'invulnerable' NBT tag to 'false' when they are in specified worlds.
  Disabled-In-Worlds:
  - other_world
  - world_name
  # Controls whether players with Invulnerability can damage other players.
  Allow-Damage-Players: false
  # Controls whether players with Invulnerability can damage mobs.
  Allow-Damage-Mobs: true
  # Controls whether players with Invulnerability will keep their food level.
  Lock-Food-Level: true
  # Controls whether players with Invulnerability will keep their oxygen level when underwater.
  Lock-Oxygen-Level: true

Additional Permissions:

  • sunlight.essential.bypass.invulnerability.world - Bypasses world restrictions.
  • sunlight.essential.bypass.invulnerability.damage - Bypasses damage restrictions.

FoodLevel

Tweaks the command used to fill up a player's hunger bar. You can choose to give them hidden saturation points along with the normal food points so they don't get hungry again right away.

FoodLevel:
  Restore:
    Saturation:
      # Controls whether the 'foodlevel' command should also give some saturation.
      Included: true
      # Sets saturation amount given by the 'foodlevel' command.
      Amount: 5.0

Health

Changes the behavior of the healing command. You can set it up so that fully healing a player also wipes away any active potion effects like poison or slowness.

Health:
  Restore:
    # Controls whether the 'health restore' command should remove all potion effects from player.
    ClearEffects: true

Near

Adjusts the command that scans for nearby players. You can set the default search block radius and fully customize the list that prints out in chat.

Near:
  # Sets default command radius.
  Radius: 200
  Format:
    # [*] Text Formations Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
    # [*] Placeholders: '%radius%', '%amount%', 'PlaceholderAPI'
    Normal:
    - <dark_gray><st>--------------------------------</st></dark_gray>
    - <gray>There are <soft_yellow><u>%amount%</u></soft_yellow> players around you:</gray>
    - ' '
    - '%entry%'
    - <dark_gray><st>--------------------------------</st></dark_gray>
    # [*] Text Formations Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
    # [*] Placeholders: '%radius%', '%amount%', 'PlaceholderAPI'
    Others:
    - <dark_gray><st>--------------------------------</st></dark_gray>
    - <gray>There are <soft_yellow><u>%amount%</u></soft_yellow> players around <white>%player_display_name%</white>:</gray>
    - ' '
    - '%entry%'
    - <dark_gray><st>--------------------------------</st></dark_gray>
    # Player entry format.
    # [*] Text Formations Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
    # [*] Placeholders: '%distance%', '%direction%', 'PlaceholderAPI'
    Entry: <head:"%player_name%"> <gray>%player_prefix%<click:suggest_command:"/ptp request %player_name%"><hover:show_text:"<gray>Click to send teleport request.</gray>"><white>%player_display_name%</white></hover></click>%player_suffix% <dark_gray>(<gray>%distance% blocks %direction%</gray>)</dark_gray></gray>

Nick

Sets the rules for players creating custom nicknames. You can restrict the minimum and maximum character length, block specific swear words, and use a regex pattern to limit which letters and numbers are allowed.

Nick:
  Length:
    Min: 3
    Max: 16
  Banned-Words:
  - ass
  - shit
  - admin
  Regex-Pattern: '[a-zA-Zа-яА-Я0-9_\s]*'

PlayerInfo

Designs the output of the player info command. This acts like a 'whois' command, and you can display a ton of details about a player like their current health, location, UUID, and game mode.

PlayerInfo:
  # PlaceholderAPI is supported here.
  # [*] Text Formation Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
  Format:
  - <dark_gray><st>------------</st></dark_gray> <gray><soft_yellow>%player_name%</soft_yellow> Info</gray> <dark_gray><st>------------</st></dark_gray>
  - ' '
  - '<dark_gray>» </dark_gray><sprite:"gui":"server_list/ping_5"><gray> Status: </gray><green>%player_status%</green>'
  - '<dark_gray>» </dark_gray><sprite:"items":"item/clock_12"><gray> Since: </gray><white>%player_last_seen%</white>'
  - ' '
  - '<dark_gray>» </dark_gray><gray>UUID: </gray><click:copy_to_clipboard:"%player_uuid%"><hover:show_text:"<gray>Click to copy!</gray>"><white>%player_uuid%</white></hover></click>'
  - '<dark_gray>» </dark_gray><gray>Name: </gray><click:copy_to_clipboard:"%player_name%"><hover:show_text:"<gray>Click to copy!</gray>"><white>%player_name%</white></hover></click>'
  - '<dark_gray>» </dark_gray><gray>Nickname: </gray><click:copy_to_clipboard:"%player_display_name%"><hover:show_text:"<gray>Click to copy!</gray>"><white>%player_display_name%</white></hover></click>'
  - '<dark_gray>» </dark_gray><gray>IP: </gray><click:copy_to_clipboard:"%player_ip%"><hover:show_text:"<gray>Click to copy!</gray>"><white>%player_ip%</white></hover></click>'
  - ' '
  - '<dark_gray>» </dark_gray><sprite:"items":"item/compass_15"><gray> Location: </gray><white><red>%location_x%</red> <green>%location_y%</green> <blue>%location_z%</blue> @ %location_world%</white> <click:run_command:"/tppos %location_x% %location_y% %location_z% %location_world%"><soft_yellow>[Teleport]</soft_yellow></click>'
  - '<dark_gray>» </dark_gray><sprite:"items":"item/nether_star"><gray> Game Mode: </gray><white>%player_gamemode%</white>'
  - '<dark_gray>» </dark_gray><sprite:"items":"item/feather"><gray> Can Fly: </gray>%player_can_fly%'
  - '<dark_gray>» </dark_gray><sprite:"items":"item/experience_bottle"><gray> XP Level: </gray>%player_level%'
  - '<dark_gray>» </dark_gray><sprite:"gui":"hud/food_full"><gray> Hunger / Saturation: </gray><white>%player_food_level%</white><gray> / </gray><soft_orange>%player_saturation%</soft_orange>'
  - '<dark_gray>» </dark_gray><sprite:"gui":"hud/heart/full"><gray> Health / Max. Health: </gray><white>%player_health%❤</white><gray> / </gray><soft_red>%player_max_health%❤</soft_red>'
  - '<dark_gray>» </dark_gray><sprite:"gui":"mob_effect/invisibility"><gray> Vanished: </gray><white>%player_vanished%</white>'
  - ' '
  - <dark_gray><st>--------------------------------</st></dark_gray>

Staff

Configures the command that shows online staff members. You just tell it which permission groups count as staff, and it builds a formatted list for players to read.

Staff:
  # Player ranks considered as staff.
  IncludedRanks:
  - admin
  - moderator
  - helper
  Format:
    # [*] Text Formations Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
    # [*] Placeholders: '%amount%'
    List:
    - <dark_gray><st>--------------------------------</st></dark_gray>
    - <gray>There are <soft_red><u>%amount%</u></soft_red> staff players online:</gray>
    - ' '
    - '%entry%'
    - <dark_gray><st>--------------------------------</st></dark_gray>
    # [*] Text Formations Guide: https://nightexpressdev.com/nightcore/configuration/text-formation/
    # [*] Placeholders: '%player_prefix%', '%player_suffix%', 'PlaceholderAPI'
    Entry: <head:"%player_name%"> <gray>%player_prefix%<click:suggest_command:"/msg %player_name% "><hover:show_text:"<gray>Click to write private message.</gray>"><white>%player_display_name%</white></hover></click>%player_suffix%</gray>

Time

Tweaks the command used to check or change the server time. You can set up easy word shortcuts (like typing sunset instead of 12000 ticks) and format the layout used when checking the current time.

Time:
  Aliases:
    noon: 6000
    night: 13000
    sunrise: 23000
    midnight: 18000
    sunset: 12000
    day: 1000
  Show:
    Format:
    - <dark_gray><st>------------</st></dark_gray> <gray>Time Info</gray> <dark_gray><st>------------</st></dark_gray>
    - '<dark_gray>» </dark_gray><gray>World: <white>%world%</white></gray>'
    - '<dark_gray>» </dark_gray><gray>World Time: <soft_yellow>%time%</soft_yellow> (<white>%ticks% ticks</white>)</gray>'
    - '<dark_gray>» </dark_gray><gray>Server Time: <soft_blue>%global%</soft_blue></gray>'
    - <dark_gray><st>--------------------------------</st></dark_gray>

Commands

The table below shows default command settings. Please see the Commands Guide on how to toggle and customize SunLight's commands.

Standalone Commands [?]

Command Arguments Description Permission Default State
/addair amount player -s Add air ticks to yourself or a player. sunlight.essential.command.air.add
sunlight.essential.command.air.others
OFF
/setair amount player -s Set air ticks for yourself or a player. sunlight.essential.command.air.set
sunlight.essential.command.air.others
OFF
/removeair amount player -s Remove air ticks from yourself or a player. sunlight.essential.command.air.remove
sunlight.essential.command.air.others
OFF

Root Command [?]

Command Arguments Permission Default State
/air help add remove set sunlight.essential.command.air.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/bring /tphere /movehere player -s Teleport player to yourself. sunlight.essential.command.bring ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/broadcast text Broadcast a message to all online players. sunlight.essential.command.broadcast ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/condense - Condense inventory items into blocks. sunlight.essential.command.condense ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/coords /tppos /tploc x y z world player -s Teleport yourself or a player to coordinates. sunlight.essential.command.coords
sunlight.essential.command.coords.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/dimension /dim world player -s Teleport yourself or a player to a world. sunlight.essential.command.dimension
sunlight.essential.command.dimension.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/disposal /trash player -s Open virtual disposal for yourself or a player. sunlight.essential.command.disposal
sunlight.essential.command.disposal.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/enchant slot enchantment level player -s Enchant item in a slot. sunlight.essential.command.enchant
sunlight.essential.command.enchant.others
ON
/disenchant slot enchantment player -s Disenchant item in a slot. sunlight.essential.command.disenchant
sunlight.essential.command.disenchant.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/addlevel amount player -s Add XP level(s) to yourself or a player. sunlight.essential.command.experience.level
sunlight.essential.command.experience.level.others
ON
/setlevel amount player -s Set XP level(s) for yourself or a player. sunlight.essential.command.experience.level
sunlight.essential.command.experience.level.others
ON
/removelevel amount player -s Remove XP level(s) from yourself or a player. sunlight.essential.command.experience.level
sunlight.essential.command.experience.level.others
ON
/addxp amount player -s Add raw XP to yourself or a player. sunlight.essential.command.experience.xp
sunlight.essential.command.experience.xp.others
ON
/setxp amount player -s Set raw XP for yourself or a player. sunlight.essential.command.experience.xp
sunlight.essential.command.experience.xp.others
ON
/removexp amount player -s Remove raw XP from yourself or a player. sunlight.essential.command.experience.xp
sunlight.essential.command.experience.xp.others
ON

Root Command [?]

Command Arguments Permission Default State
/experience /exp /xp help add remove set
addlevel removelevel setlevel
sunlight.essential.command.experience.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/ignite time player -s Ignite yourself or a player. sunlight.essential.command.ignite
sunlight.essential.command.ignite.others
ON
/extinguish player -s Extinguish yourself or a player. sunlight.essential.command.extinguish
sunlight.essential.command.extinguish.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/fly /togglefly
/fly-on
/fly-off
player -s Toggle fly on/off for yourself or a player. sunlight.essential.command.fly
sunlight.essential.command.fly.others
ON

Root Command [?]

Command Arguments Permission Default State
/flymode help toggle on off sunlight.essential.command.fly.root OFF

Standalone Commands [?]

Command Arguments Description Permission Default State
/flyspeed speed player -s Set fly speed for yourself or a player. sunlight.essential.command.flyspeed
sunlight.essential.command.flyspeed.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/addfood amount player -s Add food points to yourself or a player. sunlight.essential.command.foodlevel.add
sunlight.essential.command.foodlevel.others
OFF
/setfood amount player -s Set food points for yourself or a player. sunlight.essential.command.foodlevel.set
sunlight.essential.command.foodlevel.others
OFF
/removefood amount player -s Remove food points from yourself or a player. sunlight.essential.command.foodlevel.remove
sunlight.essential.command.foodlevel.others
OFF
/feed player -s Feed yourself or a player. sunlight.essential.command.foodlevel.restore
sunlight.essential.command.foodlevel.others
ON

Root Command [?]

Command Arguments Permission Default State
/foodlevel help add set remove restore sunlight.essential.command.foodlevel.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/forcerun player command Force player to run a command. sunlight.essential.command.forcerun ON

This command can not be used on players with the sunlight.essential.command.forcerun.bypass permission.

Standalone Commands [?]

Command Arguments Description Permission Default State
/forcesay player text Force player to send a chat message. sunlight.essential.command.forcesay ON

This command can not be used on players with the sunlight.essential.command.forcesay.bypass permission.

Standalone Commands [?]

Command Arguments Description Permission Default State
/gms /survival player -s Set yourself or a player to Survival. sunlight.essential.command.gamemode.survival
sunlight.essential.command.gamemode.others
ON
/gmsp /spectator player -s Set yourself or a player to Spectator. sunlight.essential.command.gamemode.spectator
sunlight.essential.command.gamemode.others
ON
/gma /adventure player -s Set yourself or a player to Adventure. sunlight.essential.command.gamemode.adventure
sunlight.essential.command.gamemode.others
ON
/gmc /creative player -s Set yourself or a player to Creative. sunlight.essential.command.gamemode.creative
sunlight.essential.command.gamemode.others
ON

Root Command [?]

Command Arguments Permission Default State
/gm /gamemode help survival spectator adventure creative sunlight.essential.command.gamemode.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/goto /tpto /moveto player -s Teleport to a player. sunlight.essential.command.goto ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/hat - Equip hand item as helmet. sunlight.essential.command.hat ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/addhealth amount player -s Add health points to yourself or a player. sunlight.essential.command.health.add
sunlight.essential.command.health.others
OFF
/sethealth amount player -s Set health points for yourself or a player. sunlight.essential.command.health.set
sunlight.essential.command.health.others
OFF
/removehealth amount player -s Remove health points from yourself or a player. sunlight.essential.command.health.remove
sunlight.essential.command.health.others
OFF
/heal player -s Heal yourself or a player. sunlight.essential.command.health.restore
sunlight.essential.command.health.others
ON

Root Command [?]

Command Arguments Permission Default State
/health /hp help add set remove restore sunlight.essential.command.health.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/invulnerability /god
/invulnerability-on /god-on
/invulnerability-off /god-off
player -s Toggle invulnerability on/off for yourself or a player. sunlight.essential.command.invulnerability
sunlight.essential.command.invulnerability.others
ON

For extra settings and permissions, see Invulnerability.

Standalone Commands [?]

Command Arguments Description Permission Default State
/move /tpplayer player target -s Teleport player to another player. sunlight.essential.command.move ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/near player Show nearby players to yourself or another player. sunlight.essential.command.near
sunlight.essential.command.near.others
ON

Players with sunlight.essential.command.near.exclude permission will not show up in list.

Standalone Commands [?]

Command Arguments Description Permission Default State
/changenick name Change your own custom nick. sunlight.essential.command.nick.change ON
/clearnick player -s Clear custom nick from yourself or a player. sunlight.essential.command.nick.clear
sunlight.essential.command.nick.clear.others
ON
/setnick player name -s Set custom nick for a player. sunlight.essential.command.nick.set ON

Root Command [?]

Command Arguments Permission Default State
/nickname help change clear set sunlight.essential.command.nick.root ON

Extra permissions:

  • sunlight.essential.command.nick.colors - Allows to use colors in custom names.
  • sunlight.essential.command.nick.bypass.words - Bypasses banned worlds.
  • sunlight.essential.command.nick.bypass.length - Bypasses length check.
  • sunlight.essential.command.nick.bypass.regex - Bypasses regex check.

Standalone Commands [?]

Command Arguments Description Permission Default State
/playerinfo /pinfo player Show generic player info. sunlight.essential.command.playerinfo ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/pday /pnoon /psunset
/pnight /pmidnight /psunrise
player -s Set personal predefined world time for yourself or a player. sunlight.essential.command.playertime.set
sunlight.essential.command.playertime.set.others
OFF
/setplayertime time player -s Set personal world time for yourself or a player. sunlight.essential.command.playertime.set
sunlight.essential.command.playertime.set.others
OFF
/resetplayertime player -s Reset personal world time for yourself or a player. sunlight.essential.command.playertime.reset
sunlight.essential.command.playertime.reset.others
OFF

Root Command [?]

Command Arguments Permission Default State
/playertime /ptime help set reset
day noon sunset
night midnight sunrise
sunlight.essential.command.playertime.root ON

See Time to configure custom time aliases like day, noon, night, etc.

Standalone Commands [?]

Command Arguments Description Permission Default State
/skull /playerhead /customhead name-url-base64 Get your own, custom, or specified player's head. sunlight.essential.command.skull
sunlight.essential.command.skull.others
sunlight.essential.command.skull.custom
ON

To get a custom head, you'll need a URL or Base64 value of it. You can get ones at Minecraft Heads.

URL Example:

http://textures.minecraft.net/texture/175690cf6292955b58cad10cd9e7f0176e5b460f24d5106c6910aa356e210b8

or simply

175690cf6292955b58cad10cd9e7f0176e5b460f24d5106c6910aa356e210b8

Base64 Example:

eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMTc1NjkwY2Y2MjkyOTU1YjU4Y2FkMTBjZDllN2YwMTc2ZTViNDYwZjI0ZDUxMDZjNjkxMGFhMzU2ZTIxMGI4In19fQ==

Standalone Commands [?]

Command Arguments Description Permission Default State
/smite player -s Strike player with lightning. sunlight.essential.command.smite ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/speed speed player -s Set walk speed for yourself or a player. sunlight.essential.command.speed
sunlight.essential.command.speed.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/staff - Show online staff members. sunlight.essential.command.staff ON

See Staff to configure staff list and affected ranks.

Standalone Commands [?]

Command Arguments Description Permission Default State
/suicide - Commit suicide (set health to 0). sunlight.essential.command.suicide ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/surface /tptop /movetop player -s Teleport yourself or a player to highest place above. sunlight.essential.command.surface
sunlight.essential.command.surface.others
ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/day /noon /sunset
/night /midnight /sunrise
world Set predefined time for a world. sunlight.essential.command.time.set ON
/setworldtime time world Set specific time for a world. sunlight.essential.command.time.set ON
/worldtime world Show current world time. sunlight.essential.command.time.show ON

Root Command [?]

Command Arguments Permission Default State
/time help set show
day noon sunset
night midnight sunrise
sunlight.essential.command.time.root ON

See Time to configure custom time aliases like day, noon, night, etc.

Standalone Commands [?]

Command Arguments Description Permission Default State
/clear world Set clear weather for a world. sunlight.essential.command.weather.clear ON
/storm world Set storm in a world. sunlight.essential.command.weather.storm ON
/thunderstorm world Set thunderstorm in a world. sunlight.essential.command.weather.thunderstorm ON

Root Command [?]

Command Arguments Permission Default State
/weather help clear storm thunderstorm sunlight.essential.command.weather.root ON

Placeholders

When this module is enabled, the following placeholders will be registered in PlaceholderAPI plugin:

Placeholder Description
%sunlight_essential_invulnerability_state% Returns localized Yes or No whether player has Invulnerability enabled.
%sunlight_essential_invulnerability_bool% Returns unformatted boolean true or false whether player has Invulnerability enabled.
%sunlight_essential_custom_name% Returns custom player name (or real one if none).