From 0e412a660ff4752e447c491eb44dd5478f6f459b Mon Sep 17 00:00:00 2001 From: Ardakaz Date: Mon, 26 May 2025 12:51:49 +0000 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d3c44aa..30f0355 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # Exec -Makes possible to run external scripts via commands. \ No newline at end of file +Exec is a Minecraft server plugin that makes possible to run external scripts via commands. The scripts can be written with Bash or Python for example and the code changes don't need a server restart. + +[PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is required. You might also want to use [mcrcon](https://github.com/Tiiffi/mcrcon) for script output. + +## Config + commands: + examplecommand: + script: "/path/to/your/script %player_name% %args%" + permission: "exec.example" + +The Exec config looks like this. You can use the following placeholders: +* %args% means all arguments provided to the command. +* %arg_1%, "arg_2" can be used to read arguments too. +* PlaceholderAPI is supported (and usually required). %player_name% is the most useful one. + +You can use `/exec reload` to reload the config. \ No newline at end of file