-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
261888c
commit 2c47abc
Showing
1 changed file
with
98 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,108 @@ | ||
|
||
# Smelly Chat | ||
|
||
Welcome to Smelly chat. A fully customizable chat rank addon in minecraft bedrock. | ||
That makes server ownership eaiser, faster and enjoyable. | ||
|
||
## Features | ||
|
||
Smelly Chat is coded in the Brand new Smelly API V3. This API is extremly Powerful it builds and expands all the possibilites making this anti-cheat possible | ||
Smelly Chat is feature loaded to the most possible things to add to a | ||
chat rank addon like: | ||
|
||
- Instant Loaded Ranks | ||
- Cooldown System | ||
- Customizable config.js | ||
- Default chat ranks | ||
- Built in Tick Scheduling system and verious formatting options | ||
- Simple 1 command ranks | ||
|
||
|
||
## Commands | ||
|
||
Add a Chat rank to a player | ||
``` | ||
/tag @s add rank-Owner | ||
``` | ||
To add another rank simply just run the command again | ||
``` | ||
/tag @s add rank-Staff | ||
``` | ||
Remove a rank by running | ||
``` | ||
/tag @s remove rank-Staff | ||
``` | ||
|
||
## Documentation | ||
|
||
#### Editing the config | ||
```js | ||
/** | ||
* The default rank for someone with no rank on server | ||
*/ | ||
export const DEFAULT_RANK = "§bMember"; | ||
|
||
/** | ||
* Time in seconds for cooldown | ||
* Set this to 0 to disable cooldowns | ||
*/ | ||
export const CHAT_COOLDOWN = 3; | ||
``` | ||
To change the DEFAULT_RANK just edit the const | ||
```js | ||
/** | ||
* The default rank for someone with no rank on server | ||
*/ | ||
export const DEFAULT_RANK = "§bUser"; | ||
|
||
/** | ||
* Time in seconds for cooldown | ||
* Set this to 0 to disable cooldowns | ||
*/ | ||
export const CHAT_COOLDOWN = 3; | ||
``` | ||
Also you can remove the cooldown or add more time by just editing the cooldown | ||
```js | ||
/** | ||
* The default rank for someone with no rank on server | ||
*/ | ||
export const DEFAULT_RANK = "§bUser"; | ||
|
||
/** | ||
* Time in seconds for cooldown | ||
* Set this to 0 to disable cooldowns | ||
*/ | ||
export const CHAT_COOLDOWN = 0; | ||
``` | ||
|
||
**WHEN EDITING THE CONFIG MAKE SURE TO INCREMENT THE `/manifest.json` VERSION** | ||
|
||
Old: | ||
```json | ||
"header": { | ||
"name": "pack.name", | ||
"description": "pack.description", | ||
"min_engine_version": [1, 19, 0], | ||
"uuid": "4d2c7522-f064-448d-a697-9d7a1c4e4aa6", | ||
"version": [3, 0, 0] | ||
}, | ||
``` | ||
New: | ||
```json | ||
"header": { | ||
"name": "pack.name", | ||
"description": "pack.description", | ||
"min_engine_version": [1, 19, 0], | ||
"uuid": "4d2c7522-f064-448d-a697-9d7a1c4e4aa6", | ||
"version": [3, 0, 1] | ||
}, | ||
``` | ||
|
||
|
||
- Check out Smelly API: https://github.com/smell-of-curry/Smelly-API | ||
|
||
## Support | ||
|
||
As Smelly Anti-cheat is Still in beta, there might be bugs that you could face. If you need support PLEASE Join the discord and subbmit your problems here: https://discord.gg/dMa3A5UYKX | ||
Watch the most recent video by Smell of curry: | ||
https://youtu.be/zSiZrsqKSaQ | ||
|
||
For support, join the discord: https://discord.gg/dMa3A5UYKX | ||
|