> For the complete documentation index, see [llms.txt](https://epromc.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://epromc.gitbook.io/docs/ehome/readme.md).

# Overview & Introduction

Documentation for eHome - home management plugin for Paper, Purpur, and Folia.

**eHome** (`v0.0.1-RELEASE`) is a home management plugin for Paper, Purpur, and Folia servers running Minecraft 1.21+. It replaces the standard `/sethome` and `/home` commands with a bed-themed GUI and adds features like home sharing and multi-database support.

[![bStats Servers](https://img.shields.io/badge/bStats%20Servers-Active-00D26A?style=for-the-badge\&logo=minecraft\&logoColor=white)](https://bstats.org) [![Platform](https://img.shields.io/badge/platform-Paper%20%7C%20Folia%20%7C%20Purpur-00F2FE.svg?style=for-the-badge)](https://papermc.io) [![Java](https://img.shields.io/badge/java-21+-orange.svg?style=for-the-badge)](https://www.oracle.com/java/)

***

## Features

**Bed-Themed GUI** The `/homes` command opens a chest GUI where each home is represented by a colored bed. Players can choose from 16 colors, pin favorites, and browse multiple pages if they have many homes.

**Safe Teleportation** Before teleporting, eHome checks the destination for hazards — lava, fire, suffocation blocks, and drops into the void. If the saved location is unsafe, the plugin looks for a nearby safe spot before teleporting.

**Home Sharing** Players can invite others to their homes using `/home share <player> <home>`. The invited player receives a clickable **\[ACCEPT]** / **\[DECLINE]** prompt in chat. Accepted shares grant a one-time or persistent teleport depending on configuration.

**Bedrock Support** eHome integrates with Geyser and Floodgate to show native Bedrock UI forms for players connecting from mobile or console clients.

**Database Support** Supports SQLite (default), MySQL, MariaDB, PostgreSQL, and H2 through HikariCP connection pooling. Migrations run automatically on startup.

**Folia and Paper** Uses Folia region schedulers when running on Folia, and Paper's async task system otherwise. No main-thread blocking.

***

## Pages

* [Installation & Setup](/docs/ehome/getting-started/installation-and-setup.md)
* [Commands & Permissions](/docs/ehome/getting-started/commands-and-permissions.md)
* [GUI & Customization](/docs/ehome/core-features-and-mechanics/gui-and-customization.md)
* [Configuration Guide](/docs/ehome/core-features-and-mechanics/configuration-guide.md)
* [Database & Storage](/docs/ehome/core-features-and-mechanics/database-and-storage.md)

***

## Support

* Discord: [discord.gg/sVWuc49eYV](https://discord.gg/sVWuc49eYV)
* bStats: [bstats.org/plugin/bukkit/eHome](https://bstats.org/plugin/bukkit/eHome)
* Trakteer: [trakteer.id/epromite/tip](https://trakteer.id/epromite/tip)
* Ko-fi: [ko-fi.com/epromite/tip](https://ko-fi.com/epromite/tip)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://epromc.gitbook.io/docs/ehome/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.