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

# Project Essentials Home

## How to Install 

For start the modification, you **need installed Forge**, it is desirable that the version matches the supported versions. You can download Forge 1.14.4 from the [link](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.14.4.html) and Forge 1.15.2 from it [link](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.15.2.html). Move the downloaded mod to the `mods` folder (*installation example below*).

```
val MV = valueOf(your_minecraft_version)

.
├── assets
├── config
├── libraries
├── mods (that's how it should be)
│   ├── Project Essentials Core-MOD-1.MV.X-1.X.X.jar (mandatory)
│   ├── Project Essentials Cooldown-1.MV.X-1.X.X.jar (recommended)
│   ├── Project Essentials Permissions-1.MV.X-1.X.X.jar (recommended)
│   └── Project Essentials Home-1.MV.X-1.X.X.jar
└── ...
```

### **Dependencies**

Also **do not forget** to install dependencies, only two types of dependencies: **mandatory** (*game will not start without a mod*) and **recommended** (*without a mod, game can start, but I recommend using it*).

#### **Download dependencies**: [Cooldown](https://github.com/ProjectEssentials/ProjectEssentials-Cooldown) · [Core](https://github.com/ProjectEssentials/ProjectEssentials-Core) · [Permissions](https://github.com/ProjectEssentials/ProjectEssentials-Permissions)

### Last step

Now try to start the game, go to the `mods` tab, if this modification is displayed in the `mods` tab, then the mod has been **successfully installed.**

## **Configuration**

### **Configuration location**

```
.minecraft/config/ProjectEssentials/user-data/{uuid}/home.json
```

## Commands and Permissions

| Command name | Aliases                                | Permission        | Op level | Description                                                                                                                                                                                                                                                                                                                           |
| ------------ | -------------------------------------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/home`      | `/ehome`                               | `ess.home`        | `0`      | Teleport you to your home. If command executed without arguments then will be used default home name `home`. Execution example with home name `/home home2`.                                                                                                                                                                          |
| `/sethome`   | `/esethome`                            | `ess.home.set`    | `0`      | Create new home point at player position. If command executed without argument `name` then will be used default home name `home`. If home with some name exist, then command execution will be aborted if you not use argument `override`, for overriding existing home, just type `true` after home name. (`boolean` type argument). |
| `/delhome`   | `/edelhome`, `/removehome`, `/remhome` | `ess.home.remove` | `0`      | Remove existing home point with name. If command executed without arguments then home                                                                                                                                                                                                                                                 |

## If you have any questions or encounter a problem, be sure to open an [issue](https://github.com/ProjectEssentials/ProjectEssentials-Home/issues/new/choose)