update: wiki

sakurawald · Jul 25, 2024 · 370ba65 · 370ba65
1 parent f20fbeb
commit 370ba65
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/fuji-fabric.wiki b/fuji-fabric.wiki
diff --git a/src/main/java/io/github/sakurawald/config/model/ConfigModel.java b/src/main/java/io/github/sakurawald/config/model/ConfigModel.java
@@ -725,10 +725,24 @@ public class Whitelist {
         @Documentation("""
                 
                 Background:
-                  The vanilla minecraft use a command system called `brigadier`.
-                  All the commands are `registered`, `parsed` and `executed` by `brigadier`.
+                    The vanilla minecraft use a command system called `brigadier`.
+                    All the commands are `registered`, `parsed` and `executed` by `brigadier`.
                     
-                  In this system, all commands are build into a tree strucutre.
+                    In this system, all commands are build into a tree strucutre.
+                    
+                    For example, like the command `/gamemode creative Steve` is composed by 3 `command node`:
+                      - `literal command node` -> "gamemode"
+                      - `argument command node` -> a valid gamemode
+                      - `argument command node` -> a valid player
+                    
+                    And the `command node path` stands the `tree node path`.
+                    For `/gamemode creative Steve`, the path is ["gamemode", "gamemode", "target"].
+                    
+                    You can query a command path using `/lp group default permission set fuji.permission...` way.
+                    
+                    Also, each `command node` has its `requirement`, which is a condition to check if the `command user` can use the `command node`.
+                                
+                This module can `override` the `requirement` of a `command node` into a `permission` with prefix `fuji.permission.<command_node_path>`.
                                 
                 See [permission](https://github.com/sakurawald/fuji-fabric/wiki/Permission)
                 """)