Merge branch 'master' into master

Author: Alumopper

README.md

@@ -66,26 +66,22 @@ The following options are available:
 }
 ```
 
-3. Start Minecraft with the Sniffer mod installed
-4. In VSCode, press F5 or click the "Run and Debug" button
-5. Select "Connect to Minecraft" from the dropdown menu
+In this case, after the game executes `say 2`, the game will be "frozen" because it meets the breakpoint. 
 
-You can now place breakpoints in your `.mcfunction` files and execute it from the game to step through the code.
+When the game is "frozen", you can still move around, do whatever you want, just like execute the command `tick freeze`.
+So you can check the game state, or do some debugging.
 
-## Usage in Minecraft
+* Step
 
 ### Breakpoint
 
 The debugger can be controlled directly from Minecraft using the following commands:
 
-- `/breakpoint continue`: Resume execution after hitting a breakpoint
-- `/breakpoint step`: Execute the next command and pause
-- `/breakpoint step_over`: Skip to the next command in the current function
-- `/breakpoint step_out`: Continue execution until the current function returns
+* Continue
 
-All commands require operator permissions (level 2) to use.
+When the game is "frozen", you can use the command `/breakpoint move` to unfreeze the game and continue running.
 
-When execution is paused at a breakpoint, the gametick will be freezed.
+* Get Macro Arguments
 
 ### Debug Command
 
@@ -194,40 +190,44 @@ Command Syntax:
 - `watch reload`: Trigger the hot loading to apply changes.
 - `watch auto [true|false]`: Set whether auto reloading is enabled. Auto reloading will apply any change once the watcher detects it. Default is `false`. If value is not provided, it will tell you if the auto reloading is enabled.
 
-## Development
-
-### Project Structure
+say start
+#breakpoint
+$say $(msg)
+say end
+```
 
-- `src/main`: Main mod code for Minecraft
-- `src/client`: Client-side mod code
-- `vscode`: VSCode extension source code
+After executing `function test:test_macro {"msg":"test"}`, we passed the value `test` to the macro argument `msg` and 
+then the game will pause before `$say $(msg)`. At this time, you can use `/breakpoint get msg` to get the value `test`.
 
-### Building the Project
+* Get Function Stack
 
-To build the Minecraft mod:
+By using `/breakpoint stack`, you can get the function stack of the current game. For example, if we have following two
+functions:
 
-```bash
-./gradlew build
-```
+```mcfunction
+#test:test1
 
-To build the VSCode extension:
+say 1
+function test:test2
+say 2
 
-```bash
-cd vscode
-npm install
-npm run build
+#test: test2
+say A
+#breakpoint
+say B
 ```
 
-## License
-
-This project is licensed under the MPL-2.0 License - see the [LICENSE](LICENSE) file for details.
+When the game pauses at the breakpoint, you can use `/breakpoint stack` and the function stack will be printed in the
+chat screen:
 
-## Contributing
+```
+test:test2
+test:test
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+```
 
-## Acknowledgements
+* Run command in current context
 
 - [Fabric](https://fabricmc.net/) - Mod loader for Minecraft
 - [VSCode Debug Adapter](https://code.visualstudio.com/api/extension-guides/debugger-extension) - VSCode debugging API
-- [Datapack Debugger](https://github.com/Alumopper/Datapack-Debugger/) by [Alumopper](https://github.com/Alumopper) - Original implementation of the debugger, without the DAP layer
+- [Datapack Debugger](https://github.com/Alumopper/Datapack-Debugger/) by [Alumopper](https://github.com/Alumopper) - Original implementation of the debugger, without the DAP layer

gradle.properties

@@ -18,4 +18,4 @@ maven_group=net.gunivers
 archives_base_name=sniffer
 
 # Dependencies
-fabric_version=0.138.3+1.21.10
+fabric_version=0.138.3+1.21.10