Homes

The Homes allows players to set home locations and return to them at any time.


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
/delhome home Delete favorite or specific home. sunlight.homes.command.homes.delete ON
/homelist player View or own or other player's homes. sunlight.homes.command.homes.list
sunlight.homes.command.homes.list.others
ON
/sethome home Create new or update favorite home. sunlight.homes.command.homes.set ON
/home home Teleport to favorite or specific home. sunlight.homes.command.homes.teleport ON
/visithome player home Visit other player's favorite or specific home. sunlight.homes.command.homes.visit ON
/homeinvite player home Invite player to your favorite or specific home. sunlight.homes.command.homes.invite OFF

Root Command [?]

Command Arguments Permission Default State
/homes help delete list set
teleport visit invite
sunlight.homes.command.homes.root ON

Standalone Commands [?]

Command Arguments Description Permission Default State
/delplayerhome player home Delete player's favorite or specific home. sunlight.homes.command.homes.delete.others OFF
/setplayerhome player home Create new or update player's favorite home. sunlight.homes.command.homes.set.others OFF

Root Command [?]

Command Arguments Permission Default State
/homes-admin help create delete sunlight.homes.command.homes.admin ON

Permissions

Here's a list of all module permissions. Top-level wildcard * permissions grants access to all child permissions.

  • sunlight.homes.*
    • sunlight.homes.command.*
      • sunlight.homes.command.homes.root
      • sunlight.homes.command.homes.delete
      • sunlight.homes.command.homes.delete.others
      • sunlight.homes.command.homes.set
      • sunlight.homes.command.homes.set.others
      • sunlight.homes.command.homes.teleport
      • sunlight.homes.command.homes.list
      • sunlight.homes.command.homes.list.others
      • sunlight.homes.command.homes.invite
      • sunlight.homes.command.homes.visit
      • sunlight.homes.command.homes.visit.all
      • sunlight.homes.command.homes.admin
    • sunlight.homes.bypass.*
      • sunlight.homes.bypass.unsafe - Bypasses safe location check when visitting other player homes.
      • sunlight.homes.bypass.creation.worlds - Bypasses world check when creating homes.
      • sunlight.homes.bypass.creation.protection - Bypasses building access checks when creating homes.

Placeholders

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

Placeholder Description
%sunlight_homes_limit% Returns max. number of homes a player can set.
%sunlight_homes_amount% Returns number of homes a player have set.
%sunlight_homes_favorite_home% Returns the name of a favorite player's home or "None" if none.