SiHome

Overview

SiHome is a modern, lightweight and highly configurable homes plugin for Minecraft servers.

It provides a modern Dialog GUI, a Chest GUI, automatic GUI selection for different client versions, customizable home management, teleport safety, custom home icons, multilingual support, PlaceholderAPI integration, Vault and WorldGuard support, and much more.

Features

Home System

• Create, teleport to, rename and delete homes
• Configurable home limits
• Permission-based home limits
• Home slots
• Home name validation
• Configurable blocked characters
• Persistent home storage
• Home limit bypass permissions

Home Icons

• Set a custom Minecraft item as a home icon
• Change home icons at any time
• Reset a home to the default icon
• Search through available Minecraft items
• Icons are saved permanently with each home
• Automatic fallback for invalid icons

GUI System

SiHome supports both modern Dialog menus and traditional Chest menus.

Dialog GUI

The default Dialog GUI design is inspired by the home interface of the DonutSMP.

• Modern Paper Dialog interface
• Configurable columns
• Configurable button width
• Configurable tooltips
• Custom home buttons
• Show More system
• Custom item icons
• Configurable layout

Chest GUI

• inventory-based interface
• Fully configurable layouts
• Step-based Show More system
• Configurable home slots
• Configurable filler slots
• Configurable navigation buttons
• Pagination
• Manage Home menu
• Delete confirmation menu
• Change Icon menu
• Search menu

Automatic GUI Selection

The GUI can be configured with four modes:

# Always use the Dialog GUI.
gui:
  type: DIALOG

# Always use the Chest GUI.
gui:
  type: CHEST

# Automatically choose between Dialog and Chest depending on the player's client version.
gui:
  type: BOTH

# Disable the GUI.
gui:
  type: NONE

When BOTH is enabled, ViaVersion can be used to detect the actual client version. Modern supported clients can receive the Dialog GUI while older clients use the Chest GUI instead.

Custom Home Click Actions

Chest GUI home actions can be configured independently.

Example:

home-actions:
  left-click: teleport
  right-click: manage
  shift-left-click: delete
  shift-right-click: nothing

Teleport System

• Teleport countdown
• Configurable teleport delay
• Cancel teleport when the player moves
• Cancel teleport when the player takes damage
• Damage immunity after teleport
• Configurable teleport costs
• World blacklist
• WorldGuard support
• Unsafe teleport protection
• Optional teleport confirmation

Permissions

• Command permissions
• Home limit permissions
• Admin permissions
• Bypass permissions

Economy

Each command can have its own configurable cost. (vault required to work)

• /home
• /sethome
• /delhome
• /renamehome

PlaceholderAPI

SiHome provides the:

%sihome_...% PlaceholderAPI expansion.

%sihome_home_count%

%sihome_home_limit%

%sihome_has_home%

%sihome_first_home%

%sihome_last_home%

%sihome_free_slots%

%sihome_home_<number>%

%sihome_home_<number>_exists%

%sihome_home_<number>_world%

%sihome_home_<number>_x%

%sihome_home_<number>_y%

%sihome_home_<number>_z%

%sihome_home_<number>_location%

Integrations

• PlaceholderAPI
• Vault
• WorldGuard
• ViaVersion
• ViaBackwards

Languages

Messages can be sent either as regular chat messages or as Action Bar messages. The delivery type can be configured for supported messages.

language files:

en_us.yml
es_es.yml
fa_ir.yml
de_de.yml
fr_fr.yml
hi_in.ymp
ja_jp.yml
ko_kr.yml
pt_br.yml
ru_ru.yml
zh_cn.yml
tr_tr.yml
it_it.yml

Every language file can be customized.

Text Formatting

SiHome supports Legacy colors, Legacy Hex colors and MiniMessage.

• &0 - &f
• &#RRGGBB
• ...
• <#RRGGBB>...</#RRGGBB>

Configuration

files:

config.yml
dialog-gui.yml
chest-gui.yml
messages/
sprite-mapping.yml
homes.yml

You can customize GUI layouts, buttons, materials, names, lore, sounds, teleport settings, home limits, costs, messages, world restrictions and more.

Commands

• /sethome
• /home [name]
• /delhome
• /renamehome
• /homes

Admin Commands

• /sihome reload
• /sethome (player name): (home name)
• /home (player name): (home name)
• /delhome (player name): (home name)
• /renamehome (player name): (home name) (new name)

Performance

SiHome is designed to remain lightweight and avoid unnecessary work on the main server thread.