Aller au contenu principal

Home Manager

Manage player homes with permissions and cooldowns

Champs

ChampTypePar défautDescription
artifactRef<HomeArtifactDefinition>—Linked artifact_home entry that stores the player homes
HomeArtifactDefinition (3)
ChampTypePar défautDescription
artifactIdString—Identifier used for the stored artifact data. Generated once; never change it.
storageKeyStringdefaultOptional legacy suffix for migrating existing YAML files
autosaveIntervalLong6000Interval in ticks between automatic saves. Set to 0 to disable.
defaultHomesInt1Default number of homes for players without special permissions
permissionLimitsList<PermissionLimit>emptyPermission based limits that override the default home amount
PermissionLimit (3)
ChampTypePar défautDescription
permissionString—Permission to check
limitInt1Number of homes allowed when the permission is present
teleportCooldownSecondsLong?—Teleport cooldown in seconds applied when the permission is present. Leave empty to use the default cooldown.
teleportCooldownSecondsLong30Cooldown in seconds between home teleports
basePermissionString?—Permission required to use home commands
bypassPermissionStringtinyessentials.homes.bypassPermission qui leve toutes les restrictions : nombre de maisons illimite et aucun delai entre deux teleportations. Laisser vide pour n'accorder de derogation a personne.
homeSavedMessageString&aHome {home} saved.Message shown when a home is savedPlaceholders
teleportMessageString&aTeleporting to {home}...Message shown when teleporting to a homePlaceholders
cooldownMessageString&cPlease wait {cooldown}s before teleporting again.Message shown when teleport is on cooldownPlaceholders
limitMessageString&cYou can only have {limit} homes.Message shown when a player exceeds their home limitPlaceholders
removedMessageString&aHome {home} deleted.Message shown when a home is removedPlaceholders
missingHomeMessageString&cHome {home} does not exist.Message shown when a player attempts to use a missing homePlaceholders
storageUnavailableMessageString&cLe stockage des homes est indisponible pour le moment ({artifact}). Veuillez réessayer plus tard.Message shown when the home storage artifact is unavailablePlaceholders
listHeaderString&6Your homes ({count}/{limit}):Header used when listing homesPlaceholders
listEntryString&7- {home} &8({world})Format used for each home entry in the listPlaceholders
homesMenuHomesMenuConfig—Configuration of the homes inventory menu
HomesMenuConfig (9)
ChampTypePar défautDescription
titleString&8Vos homesTitle displayed on the homes menuPlaceholders
sizeInt54Size of the homes menu inventory
homeSlotsList<Int>—Slots used to render the player homes
defaultHomeItemMenuItemConfig—Default item used for homes when no custom icon is defined
MenuItemConfig (4)
ChampTypePar défautDescription
itemVar<Item>—Item template used for menu entries (supports Typewriter custom or serialized items)
loreList<String>—Lore displayed on the itemPlaceholders
customModelDataInt?—Custom model data applied to the item
glowBooleanfalseWhether the item should glow
emptyHomeItemMenuItemConfig?—Item displayed when a home slot is available but no home exists yet
MenuItemConfig (4)
ChampTypePar défautDescription
itemVar<Item>—Item template used for menu entries (supports Typewriter custom or serialized items)
loreList<String>—Lore displayed on the itemPlaceholders
customModelDataInt?—Custom model data applied to the item
glowBooleanfalseWhether the item should glow
fillerMenuItemConfig?—Filler item applied to empty slots
MenuItemConfig (4)
ChampTypePar défautDescription
itemVar<Item>—Item template used for menu entries (supports Typewriter custom or serialized items)
loreList<String>—Lore displayed on the itemPlaceholders
customModelDataInt?—Custom model data applied to the item
glowBooleanfalseWhether the item should glow
previousPageButtonMenuButtonConfig?—Button that moves to the previous page
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
nextPageButtonMenuButtonConfig?—Button that moves to the next page
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
closeButtonMenuButtonConfig?—Button that closes the menu
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
homeEditorMenuHomeEditorMenuConfig—Configuration of the home editor menu
HomeEditorMenuConfig (9)
ChampTypePar défautDescription
titleString&8Gestion de {home}Title displayed on the home editor menuPlaceholders
sizeInt27Size of the home editor menu
fillerMenuItemConfig?—Filler item applied to empty slots in the editor
MenuItemConfig (4)
ChampTypePar défautDescription
itemVar<Item>—Item template used for menu entries (supports Typewriter custom or serialized items)
loreList<String>—Lore displayed on the itemPlaceholders
customModelDataInt?—Custom model data applied to the item
glowBooleanfalseWhether the item should glow
teleportButtonMenuButtonConfig—Button used to teleport to the home
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
renameButtonMenuButtonConfig—Button used to rename the home
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
iconFromHandButtonMenuButtonConfig—Button that sets the icon using the item in the player's hand
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
resetIconButtonMenuButtonConfig—Button that resets the icon to the default configuration
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
deleteButtonMenuButtonConfig—Button used to delete the home
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
backButtonMenuButtonConfig?—Button returning to the homes list
MenuButtonConfig (2)
ChampTypePar défautDescription
slotInt0Slot used by the button
itemMenuItemConfig—Item displayed for the button
renamePromptMessageString&eEntrez le nouveau nom du home dans le chat. Tapez &ccancel &epour annuler.Message shown when a player is asked to provide a new home namePlaceholders
renameCancelledMessageString&cRenommage annulé.Message shown when a player cancels the rename flowPlaceholders
renameSuccessMessageString&aHome renommé en {home}.Message shown when a home is successfully renamedPlaceholders
renameConflictMessageString&cUn home nommé {home} existe déjà.Message shown when renaming a home fails because the name already existsPlaceholders
renameInvalidMessageString&cLe nom du home est invalide.Message shown when the provided home name is invalidPlaceholders
iconUpdatedMessageString&aIcône mise à jour pour {home}.Message shown when the home icon has been updatedPlaceholders
iconResetMessageString&eIcône réinitialisée pour {home}.Message shown when the home icon is reset to the defaultPlaceholders
iconMissingItemMessageString&cTenez un objet dans votre main principale pour définir l'icône de {home}.Message shown when the player must hold an item to update the iconPlaceholders
wikiPlaceholderStringhttps://wiki.borntocraft.fr/homesValue returned by the placeholder %tinyessentials_homes_wiki%Placeholders

How to use it​

Link an Artifact Home in artifact; it stores the homes. Without it, home commands answer that storage is unavailable.

  • defaultHomes is the number of homes every player can have. Each permissionLimits item grants limit homes (the highest matching limit wins) and may lower the teleport cooldown with its own teleportCooldownSeconds (the smallest matching value wins). teleportCooldownSeconds is the default cooldown.
  • A player with bypassPermission (default tinyessentials.homes.bypass) has no limit and no cooldown. Empty the field to give the exception to nobody.
  • basePermission, when set, is required for all home commands in addition to each command's own permission.
  • The menus are configured in homesMenu (title, size, slots, items, page buttons) and homeEditorMenu. Home names accept spaces. {home}, {limit}, {cooldown}, {count} and {world} are replaced in messages.