HikariEssentials Documentation
Updated: 2026-06-21

HikariEssentials is a GUI-focused Paper plugin for SMP servers. It combines homes, teleports, clans, offline mail, staff tools, and small quality-of-life features in one plugin.

Builds and requirements
Build JAR Target platform Java
Standard build/libs/HikariPlugins-1.0-SNAPSHOT.jar Paper 1.21.10 21 or newer
Installation

1. Put the matching JAR into plugins/.
2. Start the server.
3. Configure config.yml and, if needed, a language file.
4. Run /hikari reload after configuration changes.

Plugin data files include config.yml, messages.yml, messages_en.yml, homes.yml, clans.yml, mail.yml, companions.yml, player-settings.yml, nicknames.yml, and audit.log.


Homes and teleports
Command Purpose
/hikari Opens the main GUI
/home [name] Opens homes or teleports to one
/sethome [name] / /delhome <name> Creates or deletes a home
/tpa <player> Sends a teleport request
/tpa accept / /tpa deny Handles a request
/tp <player>, /rtp, /back Staff teleport, random teleport, or return
Home limits use homes.max-per-player; hikari.home.limit.<number> raises the limit and hikari.home.unlimited removes it. Teleport timing, cancellation, cooldowns, and RTP settings are configured under teleport.* and rtp.*.
Clans
Enable clans with clan.enabled. The system provides GUI management, invitations, customizable role names, clan chat, and a shared clan home.

Command Purpose
/clan Opens the clan GUI
/clan create <name> Creates a clan
`/clan role <leader officer
/clan sethome / /clan home Sets or uses a clan home
/cc <message> Sends clan chat
Individual switches are available under clan.features.*. Economy and claims are prepared but disabled by default.

Offline mail
/mail opens the mailbox. Use /mail send <player> <message> for known online or offline players. Left-click marks mail as read; right-click deletes it. /mail clear empties the mailbox.

Mob companion (/take)
Look at an allowed mob and run /take. It follows you on the next successful private home teleport, then is automatically unlinked. Mark it again for another transport. Clan homes, TPA, and other teleports do not move companions.


Other features and integrations
The plugin includes /ec, /craft, /nickname, /fly, /vanish, /see, and /whois, plus an audit log and configurable MOTD. The MOTD supports MiniMessage, hex colors, {online}, {max}, {server_name}, and optional PlaceholderAPI.

PlaceholderAPI, LuckPerms, Vault, and HuskChat are optional dependencies. Clan placeholders include %hikari_clan_name%, %hikari_clan_role%, %hikari_clan_member_count%, and %hikari_has_clan%.

Key player permissions include
hikari.command.home,
hikari.command.clan,
hikari.command.mail,
and hikari.command.take.

Staff permissions include
hikari.command.fly,
hikari.command.vanish,
hikari.command.see,
hikari.command.tp,
hikari.command.whois and hikari.admin.reload.