Skip to content

Commit 01af7b5

Browse files
committed
Updated readme.
1 parent cf82d25 commit 01af7b5

6 files changed

Lines changed: 8 additions & 35 deletions

File tree

assets/warp.png

529 KB
Loading

assets/warp_demo01.gif

1.91 MB
Loading

assets/warp_demo02.gif

2.02 MB
Loading

assets/warps_social.png

75.7 KB
Loading

assets/warps_social.xd

176 KB
Binary file not shown.

readme.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,15 @@
1-
## 🎆 Project Essentials: Warps
1+
<img align="right" src="assets/warps_social.png"/>
22

3-
> ## Forge modification for controlling warp points on server and client.
3+
<h2 align="center">Warp points controller provider for minecraft forge.</h2>
44

5-
#### ❗ Compatibility with forge version `28.0.X` and `28.1.X`.
5+
<h4 align="center"><a href="https://github.com/ProjectEssentials/ProjectEssentials-Warps/releases/download/v1.14.4-1.2.0.0/Project.Essentials.Warps-1.14.4-1.2.0.0.jar">Download mod</a> · <a href="documentation/for-players.md">How to install</a> · <a href="https://github.com/ProjectEssentials/ProjectEssentials-Warps/issues/new/choose">Troubleshooting</a> · <a href="https://t.me/minecraftforge">News & updates</a> · <a href="changelog.md">Change log</a></h4>
66

7-
## 🎮 Installation instructions:
8-
> ##### Just move Project Essentials Warps-1.14.4-1.X.X.X.jar to mods directory:
7+
> Just allows players to create and share warps with each other.
98

10-
> ##### Important note: don't forget install mod dependencies!
9+
#### Screenshots and demo
1110

12-
- core: <https://github.com/ProjectEssentials/ProjectEssentials-Core/releases>
13-
- permissions*: <https://github.com/ProjectEssentials/ProjectEssentials-Permissions/releases>
14-
- cooldown*: <https://github.com/ProjectEssentials/ProjectEssentials-Cooldown/releases>
11+
![](assets/warp.png)
1512

16-
* - not mandatory dependency, but recommended.
13+
![](assets/warp_demo01.gif)
1714

18-
```
19-
.
20-
├── assets
21-
├── config
22-
├── libraries
23-
├── mods (that's how it should be)
24-
│ ├── Project Essentials Warps-1.14.4-1.X.X.X.jar
25-
│ ├── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar.
26-
│ └── Project Essentials Permissions-1.14.4-1.X.X.X.jar. (recommended)
27-
│ └── Project Essentials Cooldown-1.14.4-1.X.X.X.jar. (recommended)
28-
└── ...
29-
```
30-
31-
```
32-
Information for developers:
33-
- kotlin-std lib version: 1.3.61
34-
- kotlinx serialization version: 0.14.0
35-
- target jvm version: 1.8
36-
```
37-
38-
### After you got the dependencies and the library itself:
39-
40-
# [Read the documentation to get started!](./documentation/in-using.md)
41-
42-
> ## Made with 💕 by [MairwunNx](https://mairwunnx.github.io/)
15+
![](assets/warp_demo02.gif)

0 commit comments

Comments
 (0)