Skip to content

Commit e32a172

Browse files
committed
documentation added.
1 parent aa80657 commit e32a172

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

documentation/in-using.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
> ## Documentation for basically using `Chat` module.
2+
3+
## 1. For playing and running minecraft:
4+
5+
#### 1.1 Download `Chat` mod module.
6+
7+
Visit **Chat** 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-Chat/releases>
10+
11+
#### 1.2 Install `Chat` 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 Chat-1.14.4-0.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 Chat mod 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 Chat` 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 any message in chat, if you see message `[LOCAL] [Nickname]: your message`, then the modification works as it should.
40+
41+
#### 1.4 Control your chat via minecraft commands.
42+
43+
**Not implemented yet.**
44+
45+
#### 1.5 Control your chat via configuration.
46+
47+
**I will write a little later.**
48+
49+
### For all questions, be sure to write issues!

0 commit comments

Comments
 (0)