diff --git a/Writerside/mrstudios.tree b/Writerside/mrstudios.tree index 2f8dbf7..a8c7662 100644 --- a/Writerside/mrstudios.tree +++ b/Writerside/mrstudios.tree @@ -21,6 +21,10 @@ + + + + diff --git a/Writerside/topics/cs_configuration.md b/Writerside/topics/cs_configuration.md new file mode 100644 index 0000000..e5e3201 --- /dev/null +++ b/Writerside/topics/cs_configuration.md @@ -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 +``` + + +

+ This field is a map with own structure, you must follow them to avoid issues, you can see structure scheme bellow. + + command-suggesting-map: + PERMISSION: + - LIST_ENTRY +
+ PERMISSION is permission that player must have to use that commands, + LIST_ENTRY is command name that players with this permission can use. +

+
+ +### 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: 'You can't use that command because you dont have permissions.' +``` + + +

You can use MiniMessage component formatting.

+
+ diff --git a/Writerside/topics/cs_getting_started.md b/Writerside/topics/cs_getting_started.md new file mode 100644 index 0000000..9d61d59 --- /dev/null +++ b/Writerside/topics/cs_getting_started.md @@ -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. \ No newline at end of file diff --git a/Writerside/topics/cs_index.md b/Writerside/topics/cs_index.md new file mode 100644 index 0000000..dfaff9c --- /dev/null +++ b/Writerside/topics/cs_index.md @@ -0,0 +1,3 @@ +# Command Suggester + +Start typing here... \ No newline at end of file