Skip to content

Commit

Permalink
Added documentation for demo module.
Browse files Browse the repository at this point in the history
Closes #40
Closes #61
  • Loading branch information
fulminazzo committed Dec 11, 2024
1 parent 3c5d211 commit 9645754
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
The `demo` module is a **special module** that provides a **fully functioning Spigot plugin**.
The main purpose of this module is to provide an actual **test** of **all YAGL features** for the user.

`demo` is compatible for **every Minecraft version** listed in the main page,
and uses a special programming language for all its commands: **Groovy**.

With it, `demo` gives capability to the end user to **view and modify** the code ran upon executing demo commands
**without recompiling the project**, by simply **reloading the plugin**.

All the available commands will be listed in the [resources directory](src/main/resources/commands).

0 comments on commit 9645754

Please sign in to comment.