|
| 1 | +--- |
| 2 | +title: Homes |
| 3 | +description: Homes are a powerful feature that allows players to set, manage, and teleport to custom home locations with optional permissions-based limits. |
| 4 | +--- |
| 5 | + |
| 6 | +## 🏠 Homes — teleport to personal locations |
| 7 | + |
| 8 | +Homes allow players to set their own defined locations in any world and teleport to them using simple commands. This system is permission-based and highly configurable. |
| 9 | + |
| 10 | +```yaml |
| 11 | +homes: |
| 12 | + # Default home name |
| 13 | + defaultHomeName: "home" |
| 14 | + # Time of teleportation to homes |
| 15 | + teleportTimeToHomes: "5s" |
| 16 | +``` |
| 17 | +
|
| 18 | +## 🔒 Limit homes based on permissions |
| 19 | +
|
| 20 | +You can assign a maximum number of homes to specific permissions using the `maxHomes` section. |
| 21 | + |
| 22 | +It is possible to configure the maximum number of homes for a given permission. |
| 23 | + |
| 24 | +```yaml |
| 25 | +# Homes Section |
| 26 | +homes: |
| 27 | + # Home limits per permission |
| 28 | + maxHomes: |
| 29 | + eternalcore.home.default: 1 # Default players: 1 home |
| 30 | + eternalcore.home.vip: 2 # VIP players: 2 homes |
| 31 | + eternalcore.home.premium: 3 # Premium players: 3 homes |
| 32 | + eternalcore.home.legend: 4 # Legend players: 4 homes |
| 33 | + # You can define more with the format: eternalcore.home.<unique_name> |
| 34 | +``` |
| 35 | + |
| 36 | +🎯 Example: |
| 37 | +A player with the permission `eternalcore.home.vip` can set **up to 2 homes**. |
| 38 | + |
| 39 | +📌 The plugin automatically uses the highest value from all permissions a player has. |
| 40 | + |
| 41 | +⚠️ **If a player has no matching permission, they won't be able to use the homes feature.** |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## 🎬 Homes in action |
| 46 | + |
| 47 | +<div className="grid grid-cols-1 md:grid-cols-2 gap-4 my-6"> |
| 48 | + <div className="overflow-hidden"> |
| 49 | + <img className="inline-block rounded-md shadow-sm my-4" src="/docs/eternalcore/homes/sethome.gif" alt="Setting home" /> |
| 50 | + <div className="p-2 text-center text-sm font-medium bg-muted">Setting a home with `/sethome`</div> |
| 51 | + </div> |
| 52 | + |
| 53 | + <div className="overflow-hidden"> |
| 54 | + <img className="inline-block rounded-md shadow-sm my-4" src="/docs/eternalcore/homes/home-limit-reached.gif" alt="Home limit reached" /> |
| 55 | + <div className="p-2 text-center text-sm font-medium bg-muted">Home limit reached message</div> |
| 56 | + </div> |
| 57 | + |
| 58 | + <div className="overflow-hidden"> |
| 59 | + <img className="inline-block rounded-md shadow-sm my-4" src="/docs/eternalcore/homes/delhome.gif" alt="Deleting home" /> |
| 60 | + <div className="p-2 text-center text-sm font-medium bg-muted">Deleting a home with `/delhome`</div> |
| 61 | + </div> |
| 62 | + |
| 63 | + <div className="overflow-hidden"> |
| 64 | + <img className="inline-block rounded-md shadow-sm my-4" src="/docs/eternalcore/homes/home-list.gif" alt="Listing homes" /> |
| 65 | + <div className="p-2 text-center text-sm font-medium bg-muted">Listing homes with just `/home`</div> |
| 66 | + </div> |
| 67 | +</div> |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## 🛠️ Manage player homes with `/homeadmin` |
| 72 | + |
| 73 | +The `/homeadmin` command group allows server staff and administrators to fully manage homes for other players, regardless of their permission limits or online status. |
| 74 | + |
| 75 | +import { AlertBox } from "../../../components/ui/alert-box"; |
| 76 | + |
| 77 | +<AlertBox type="warning" title="⚙️ Offline player support is coming in EternalCore 2.0!"> |
| 78 | + You'll be able to view, modify, and teleport to homes of offline players seamlessly. |
| 79 | +</AlertBox> |
| 80 | + |
| 81 | +### 💡 Examples |
| 82 | + |
| 83 | +```text |
| 84 | +/homeadmin list Steve |
| 85 | +→ Shows all homes Steve has set |
| 86 | +
|
| 87 | +/homeadmin home Alex base |
| 88 | +→ Teleports you to Alex’s “base” home |
| 89 | +
|
| 90 | +/homeadmin sethome Notch cave |
| 91 | +→ Sets Notch's home named "cave" at your current location |
| 92 | +
|
| 93 | +/homeadmin delhome Herobrine lava |
| 94 | +→ Deletes Herobrine's home named "lava" |
| 95 | +``` |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## ❓ FAQ |
| 102 | + |
| 103 | +**Q: What happens if a player loses permission to a higher home tier?** |
| 104 | + |
| 105 | +A: The player will no longer be able to create new homes above their new limit, but existing homes won't be deleted. |
| 106 | + |
| 107 | +**Q: Can I disable teleport delay?** |
| 108 | + |
| 109 | +A: Yes, you can. To do that, set `teleportTimeToHomes: "0s"`. |
0 commit comments