-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
command suggester: release documentation
- Loading branch information
Showing
4 changed files
with
60 additions
and
0 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
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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Configuration | ||
In this document, we will explain what every field in ``config.yml`` file means, and how to configure that. | ||
|
||
### Command Suggesting Map | ||
In this field, you can specify which commands the player can see and use. | ||
|
||
```yaml | ||
command-suggesting-map: | ||
mrstudios.suggester.default: | ||
- msg | ||
- friend | ||
- party | ||
mrstudios.suggester.admin: | ||
- ban | ||
- mute | ||
- kick | ||
``` | ||
<warning> | ||
<p> | ||
This field is a map with own structure, you must follow them to avoid issues, you can see structure scheme bellow. | ||
<code-block lang="yaml"> | ||
command-suggesting-map: | ||
PERMISSION: | ||
- LIST_ENTRY | ||
</code-block><br> | ||
<code>PERMISSION</code> is permission that player must have to use that commands, | ||
<code>LIST_ENTRY</code> is command name that players with this permission can use. | ||
</p> | ||
</warning> | ||
### Can Not Use That Command Message | ||
In this field, you can specify a message that a player will receive when it doesn't have permission to use command. | ||
```yaml | ||
can-not-use-that-command-message: '<red>You can't use that command because you dont have permissions.' | ||
``` | ||
<tip> | ||
<p>You can use <a href="https://docs.advntr.dev/minimessage/index.html">MiniMessage</a> component formatting.</p> | ||
</tip> | ||
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Getting Started | ||
In this document, you will find requirements that must meet to use Command Suggester plugin on your proxy server. | ||
|
||
### Java Version | ||
You need at least ``Java 17`` installed on your server. | ||
|
||
### Proxy Server Software | ||
You need at least ``1.13`` proxy server running on ``Velocity`` software, our plugin is not tested on lower versions. If you have issues on other versions, any issues will be ignored and support will be not granted. | ||
|
||
### Dependencies | ||
You need [**vPacketEvents**](https://github.com/4drian3d/VPacketEvents) with a version v1.1.0 or newer. |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Command Suggester | ||
|
||
Start typing here... |