|
| 1 | +> ## Documentation for basically using Home module. |
| 2 | +
|
| 3 | +## 1. For playing and running minecraft: |
| 4 | + |
| 5 | +#### 1.1 Download Home mod module. |
| 6 | + |
| 7 | +Visit **Home** repository on github, visit **releases** tab and download `.jar` files of latest _pre-release_ / release (**recommended**) |
| 8 | + |
| 9 | +Releases page: https://github.com/ProjectEssentials/ProjectEssentials-Home/releases |
| 10 | + |
| 11 | +#### 1.2 Install Home modification. |
| 12 | + |
| 13 | +The minecraft forge folder structure below will help you understand what is written below. |
| 14 | + |
| 15 | +> ##### Important note: don't forget install mod dependencies! |
| 16 | + - core: https://github.com/ProjectEssentials/ProjectEssentials-Core/releases |
| 17 | + - permissions: https://github.com/ProjectEssentials/ProjectEssentials-Permissions/releases |
| 18 | + |
| 19 | + |
| 20 | +``` |
| 21 | +. |
| 22 | +├── assets |
| 23 | +├── config |
| 24 | +├── libraries |
| 25 | +├── mods (that's how it should be) |
| 26 | +│ ├── Project Essentials Home-1.14.4-1.X.X.X.jar |
| 27 | +│ ├── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar. |
| 28 | +│ └── Project Essentials Permissions-1.14.4-1.X.X.X.jar. |
| 29 | +└── ... |
| 30 | +``` |
| 31 | + |
| 32 | +Place your mods and Home mods according to the structure above. |
| 33 | + |
| 34 | +#### 1.3 Verifying mod on the correct installation. |
| 35 | + |
| 36 | +Run the game, check the number of mods, if the list of mods contains `Project Essentials Home` mod, then the mod has successfully passed the initialization of the modification. |
| 37 | + |
| 38 | +After that, go into a single world, then try to write the `/home` command, if you **get an error** that you do not have permissions, then the modification works as it should. |
| 39 | + |
| 40 | +#### 1.4 Control spawn via minecraft commands. |
| 41 | + |
| 42 | +We made the commands for you: |
| 43 | + |
| 44 | +``` |
| 45 | +/home (it also alias for /home home) |
| 46 | +
|
| 47 | +OR |
| 48 | +
|
| 49 | +/home <home name> |
| 50 | +
|
| 51 | +- description: base command of home module; just teleport you to your home. |
| 52 | +
|
| 53 | +- permission: ess.home |
| 54 | +``` |
| 55 | + |
| 56 | +``` |
| 57 | +/sethome (it also alias for /sethome home) |
| 58 | +
|
| 59 | +OR |
| 60 | +
|
| 61 | +/sethome <home name> |
| 62 | +
|
| 63 | +- description: set new home with name point for command sender. |
| 64 | +
|
| 65 | +- note: if you set a new point with the same name as the old point, the old point **will be overwritten**! |
| 66 | +
|
| 67 | +- permission: ess.home.set |
| 68 | +``` |
| 69 | + |
| 70 | +``` |
| 71 | +/delhome (it also alias for /delhome home) |
| 72 | +
|
| 73 | +OR |
| 74 | +
|
| 75 | +/delhome <home name> |
| 76 | +
|
| 77 | +- description: remove named home point. |
| 78 | +
|
| 79 | +- permission: ess.home.remove |
| 80 | +``` |
| 81 | + |
| 82 | +### For all questions, be sure to write issues! |
0 commit comments