|
| 1 | +> ## Documentation for basically using Warps module. |
| 2 | +
|
| 3 | +## 1. For playing and running minecraft: |
| 4 | + |
| 5 | +#### 1.1 Download Warps mod module. |
| 6 | + |
| 7 | +Visit **Warps** 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-Warps/releases> |
| 10 | + |
| 11 | +#### 1.2 Install Warps 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 | +
|
| 17 | +- core: <https://github.com/ProjectEssentials/ProjectEssentials-Core/releases> |
| 18 | +- permissions: <https://github.com/ProjectEssentials/ProjectEssentials-Permissions/releases> |
| 19 | + |
| 20 | + |
| 21 | +``` |
| 22 | +. |
| 23 | +├── assets |
| 24 | +├── config |
| 25 | +├── libraries |
| 26 | +├── mods (that's how it should be) |
| 27 | +│ ├── Project Essentials Warps-1.14.4-1.X.X.X.jar |
| 28 | +│ ├── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar. |
| 29 | +│ └── Project Essentials Permissions-1.14.4-1.X.X.X.jar. |
| 30 | +└── ... |
| 31 | +``` |
| 32 | + |
| 33 | +Place your mods and Warps mods according to the structure above. |
| 34 | + |
| 35 | +#### 1.3 Verifying mod on the correct installation. |
| 36 | + |
| 37 | +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. |
| 38 | + |
| 39 | +After that, go into a single world, then try to write the `/warp test` command, if you **get "warp not exist"**, then the modification works as it should. |
| 40 | + |
| 41 | +#### 1.4 Control your warps via minecraft commands. |
| 42 | + |
| 43 | +We made the commands for you: |
| 44 | + |
| 45 | +``` |
| 46 | +/warp <warp name> |
| 47 | +
|
| 48 | +- description: base command of warps module; just teleport you to target warp point. |
| 49 | +
|
| 50 | +- permission: ess.warp |
| 51 | +``` |
| 52 | + |
| 53 | +``` |
| 54 | +/setwarp <warp name> |
| 55 | +
|
| 56 | +- description: set new warp point and now it warp point pnly owned by you. |
| 57 | +
|
| 58 | +- permission: ess.warp.set |
| 59 | +``` |
| 60 | + |
| 61 | +``` |
| 62 | +/delwarp <warp name> |
| 63 | +
|
| 64 | +- description: remove named warp point. |
| 65 | +
|
| 66 | +- note: only warp owner can remove target warp point! |
| 67 | +
|
| 68 | +- permission: ess.warp.remove |
| 69 | +``` |
| 70 | + |
| 71 | +### For all questions, be sure to write issues! |
0 commit comments