diff --git a/README.md b/README.md index 89e1475..5525c6a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # NbsPlayerDemo -This is a simple plugin to test functionality of .nbs (Note Block Studio) files +This is a simple plugin to test functionality of .nbs (Note Block Studio) files and the NoteBlockAPI by koca2000 + +# How to use + +Compile this plugin with maven via `mvn clean install` or download it from the release page (https://github.com/Peddach/NbsPlayerDemo/releases) and drag and drop it into your /plugins/ directory. Start your server and you will see a new directory in /plugin/NbsDemo/ which is named Songs. Put all your .nbs files in it, restart your server, and play them with /songs. Also, NoteBlockAPI is required to run this plugin (https://www.spigotmc.org/resources/noteblockapi.19287/).