Skip to content

Commit 3b0f422

Browse files
committed
📚docs: create usable readme
1 parent d2fb52c commit 3b0f422

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

‎README.md‎

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
Discord: https://discord.gg/xsnRygn5
2-
!
1+
# rChat
2+
3+
<p align="center">
4+
5+
![made with crayons](https://forthebadge.com/images/badges/made-with-crayons.svg)
6+
7+
[![DISCORD](https://img.shields.io/discord/927686860380188732?style=for-the-badge)](https://discord.gg/UMmku5fka7)
8+
9+
![LICENCE](https://img.shields.io/github/license/rcode-pro/RCodeChat?style=for-the-badge)
10+
11+
</p>
12+
13+
rChat is a plugin for simple, but effincient minecraft chat management
14+
15+
## Instalation
16+
17+
drop `.jar` file into your `/plugins` folder
18+
19+
Works on **spigot / spigot forks** servers
20+
21+
Supported minecraft versions are `1.8-1.18.1`
22+
23+
## Commands
24+
25+
All commands require user to have permission that is specified in [config.yml](https://github.com/rcode-pro/RCodeChat#Permissions)
26+
27+
### List
28+
29+
- **/chat on**
30+
- **/chat off**
31+
- **/chat [cc/clear]**
32+
33+
## Permissions
34+
35+
To set permission for using admin commands go to `plugins/RChat/config.yml` and edit 5th line
36+
37+
```yml
38+
permission: "your.permission.goes.here"
39+
```
40+
41+
\
42+
To set permission that allows user to type in disabled chat go to 6th line
43+
44+
```yml
45+
permissiontoWriteifDisabled: "your.second.permission.goes.here"
46+
```

0 commit comments

Comments
 (0)