Update README.md

README.md

@@ -1,21 +1,100 @@
-## fabric-mod-template
+# Vulpeus carpet addition
 
-[![License](https://img.shields.io/github/license/Fallen-Breath/fabric-mod-template.svg)](http://www.gnu.org/licenses/lgpl-3.0.html)
-[![workflow](https://github.com/Fallen-Breath/fabric-mod-template/actions/workflows/gradle.yml/badge.svg)](https://github.com/Fallen-Breath/fabric-mod-template/actions/workflows/gradle.yml)
+carpet addition made for vulpeus.
+Supported version is only main version of our server.
 
-fallen's fabric mod template
+## rule
 
-If you find it helpful, a credit to this template in your project will be greatly appreciated
+Show rules only in the latest release or current development version.
 
-## To use
+### commandHat
 
-1. Clone / Use this template to get a new project
-2. Search `[FEATURE]` in the project, delete or uncomment those addons
-3. Setup the mod
-    - Edit java package name
-    - Edit [gradle.properties](gradle.properties) for mod id / name etc.
-    - Edit mod name in [bug_report.yml](.github/ISSUE_TEMPLATE/bug_report.yml)
-    - Edit [common.gradle](common.gradle) for mod file location constants
-    - Change the Minecraft versions in [settings.json](settings.json), [build.gradle](build.gradle), and files in the [versions](versions) folder
-    - Search `template` in the project to see if there are any missing unedited stuffs
-4. Edit [README](README.md) for the new mod
+Enable `/hat` command. Ported from essential addons.
+
+- Type: `String`
+- Default value: `ops`
+- Allowed options: `true`, `false`, `ops`, `0`, `1`, `2`, `3`, `4`
+- Categories: `SURVIVAL`, `COMMAND`, `VULPEUS`
+
+### commandSit
+
+Enable `/sit` command. Ported from PCA.
+
+- Type: `String`
+- Default value: `ops`
+- Allowed options: `true`, `false`, `ops`, `0`, `1`, `2`, `3`, `4`
+- Categories: `SURVIVAL`, `COMMAND`, `VULPEUS`
+
+### commandView
+
+Enable `/view` command to change viewDistance of carpet.
+
+- Type: `String`
+- Default value: `ops`
+- Allowed options: `true`, `false`, `ops`, `0`, `1`, `2`, `3`, `4`
+- Categories: `SURVIVAL`, `COMMAND`, `VULPEUS`
+
+### defaultOpLevel
+
+Set the OP level granted when you join the server. can be re-granted by rejoining and can
+override `op-permission-level` in the server.properties.
+
+- Type: `int`
+- Default value: `0`
+- Categories: `CREATIVE`,`VULPEUS`
+
+### disableCCECrash
+
+yeet the server crash caused by ClassCastException.
+
+- Type: `boolean`
+- Default value: `false`
+- Categories: `VULPEUS`
+
+### disableSOECrash
+
+yeet the server crash caused by StackOverflowError.
+
+- Type: `boolean`
+- Default value: `false`
+- Categories: `VULPEUS`
+
+### optmizedDragonRespawn
+
+Optimize dragon respawn method. Ported from carpet AMS addition.
+> [!WARNING]
+> Couldn’t ensure same behavior as vanilla Minecraft after enabling this rule.
+
+- Type: `boolean`
+- Default value: `false`
+- Categories: `OPTIMIZATION`, `VULPEUS`
+
+## command
+
+### hat
+
+`/hat` : Equip the item you have on your own head. Totem of undying or non-empty shulker box cannot
+be equipped.Also you cannot use this command if you already equip the item enchanted curse of
+binding.
+
+### sit
+
+`/sit` : sit on the spot.
+
+### view
+
+`/view` :  display current viewDistance
+
+`/view [<distance>]` : change the value of viewDistance in carpet
+
+`[<distance>]` : must be between `0` to `32`
+
+### playerActions
+
+`/player [<name>] fill [<state>]`
+
+`/player [<name>] clean [<state>]`
+
+`[<name>]` : fake player name
+
+`[<state>]` : `true` or `false`