Skip to content

Commit 83005fc

Browse files
committed
readme.md updated.
1 parent ff245f1 commit 83005fc

File tree

3 files changed

+17
-28
lines changed

3 files changed

+17
-28
lines changed

assets/home_social.png

118 KB
Loading

assets/home_social.xd

277 KB
Binary file not shown.

readme.md

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,26 @@
1-
## 🏡 Project Essentials: Home
1+
# ![image](assets/home_social.png)
22

3-
> ## Forge modification for controlling player homes point on server and client
3+
## Lightweight home controller provider for forge
44

5-
#### ❗ Compatibility with forge `28.0.X` version.
5+
### Explore
66

7-
## 🎮 Installation instruction:
8-
> ##### Just move Project Essentials Home-1.14.4-1.X.X.X.jar to mods directory:
7+
#### [Download mod](https://github.com/ProjectEssentials/ProjectEssentials-Home/releases/download/v1.14.4-1.1.0/Project.Essentials.Home-1.14.4-1.1.0.jar) · [How to install](documentation/how-install.md) · [Troubleshooting](https://github.com/ProjectEssentials/ProjectEssentials-Home/issues/new/choose) · [CurseForge](https://www.curseforge.com/minecraft/mc-mods/ProjectEssentials-Home) · [Change log](changelog.md)
98

10-
> ##### Important note: don't forget install mod dependencies!
11-
- core: https://github.com/ProjectEssentials/ProjectEssentials-Core/releases
12-
- permissions: https://github.com/ProjectEssentials/ProjectEssentials-Permissions/releases
9+
### Commands and Permissions
1310

14-
```
15-
.
16-
├── assets
17-
├── config
18-
├── libraries
19-
├── mods (that's how it should be)
20-
│ ├── Project Essentials Home-1.14.4-1.X.X.X.jar
21-
│ ├── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar.
22-
│ └── Project Essentials Permissions-1.14.4-1.X.X.X.jar.
23-
└── ...
24-
```
11+
|Command name |Aliases |Permission |Op level |Description |
12+
|----- |----- |---- |---- |---- |
13+
|`/home` |`/ehome` |`ess.home` |`2` |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`.|
14+
|`/sethome` |`/esethome` |`ess.home.set` |`2` |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).|
15+
|`/delhome` |`/edelhome`, `/removehome`, `/remhome` |`ess.home.remove` |`2` |Remove existing home point with name. If command executed without arguments then home with name `home` will be removed.|
2516

26-
```
27-
Additional information:
28-
- kotlin-std lib version: 1.3.50
29-
- kotlinx serialization version: 0.12.0
30-
- target jvm version: 1.8
31-
```
17+
### Compatibility
3218

33-
### After you got the dependencies and the library itself:
19+
This mod branch supported forge version `28.0.X` and `28.1.X` (Minecraft `1.14.4`).
3420

35-
# [getting started with read the commands documentation](./documentation/in-using.md)
21+
### Credits
3622

37-
> ## Made with 💕 by [MairwunNx](https://mairwunnx.github.io/)
23+
- Author: Pavel Erokhin [@mairwunnx](https://github.com/mairwunnx)
24+
- [JetBrains](https://www.jetbrains.com/) for Licenses
25+
26+
[![image](https://github.com/ProjectEssentials/ProjectEssentials-Core/raw/MC-1.14.4/assets/support_social.png)](https://ko-fi.com/mairwunnx)

0 commit comments

Comments
 (0)