KnarCraft/Minstrel
KnarCraft/Minstrel
1
0
Fork 0
Code Issues 4 Pull Requests Projects Releases Wiki Activity

Fixes some minor README issues

Browse Source
This commit is contained in:
Kristian Knarvik 2022-10-30 22:46:53 +01:00
parent 9fd25b90f7
commit 7106060b92
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.MD
View File

@ -6,9 +6,6 @@ can create within the Spigot API. While kind of hard to set up, this allows usin
To make music hear-able only within the area of an NPC, you must make sure the track is Mono (1 channel). If you use a To make music hear-able only within the area of an NPC, you must make sure the track is Mono (1 channel). If you use a
Stereo (2 channels) soundtrack, you'll hear the music everywhere, which is cool if you want to stream music globally. Stereo (2 channels) soundtrack, you'll hear the music everywhere, which is cool if you want to stream music globally.
Volume between 0 and 1 decides how loud the volume is. If volume is set above 1, it will still play at full volume, but
can be heard further away.
## Dependencies ## Dependencies
- Citizens - Citizens
@ -24,18 +21,19 @@ There are limitations connected to directly playing media using playSound:
are ideal. are ideal.
- Songs are really only identified by the category and the song id. Stopping the song for one minstrel will also stop - Songs are really only identified by the category and the song id. Stopping the song for one minstrel will also stop
the song if played by any other minstrels at the same time. As songs are only stopped if a song has been played for a the song if played by any other minstrels at the same time. As songs are only stopped if a song has been played for a
player outside the global cycle, it shouldn't be too much of a problem, but if several minstrels play the same song, player outside the global cycle, or if volume/pitch is changed and force update is set to true, it shouldn't be too
there may be silent minstrels until the next song plays. much of a problem, but if several minstrels play the same song, there may be silent minstrels until the next song
plays.
## Commands ## Commands
| Command | Arguments | Description | | Command | Arguments | Description |
| --- | --- | --- | | --- | --- | --- |
| /minstrel addsong | <sound category> <sound identifier> <duration> | Adds the specified song to the selected minstrel's playlist | | /minstrel addsong | \<sound category> \<sound identifier> \<duration> | Adds the specified song to the selected minstrel's playlist |
| /minstrel removesong | <index (0-10000)> | Removes the song at the given index from the selected minstrel's playlist | | /minstrel removesong | \<index (0-10000)> | Removes the song at the given index from the selected minstrel's playlist |
| /minstrel listsongs | none | Lists all songs in the selected NPC's playlist in the format CATEGORY:identifier:duration | | /minstrel listsongs | none | Lists all songs in the selected NPC's playlist in the format CATEGORY:identifier:duration |
| /minstrel volume | <new volume (0.01 to 10000)> \[force update (true/false)] | Displays or sets the volume of the selected minstrel | | /minstrel volume | \<new volume (0.01 to 10000)> \[force update (true/false)] | Displays or sets the volume of the selected minstrel |
| /minstrel pitch | <new pitch (0.01 to 10000)> \[force update (true/false)] | Displays or sets the pitch of the selected minstrel | | /minstrel pitch | \<new pitch (0.01 to 10000)> \[force update (true/false)] | Displays or sets the pitch of the selected minstrel |
### /minstrel addsong ### /minstrel addsong
@ -60,8 +58,8 @@ Example: `/minstrel removesong 0` removes the first song in the playlist.
### /minstrel volume ### /minstrel volume
- new volume - The new volume of the minstrel. Set to 1 for full volume, 0.5 for half volume, etc. If set above 1, the - new volume - The new volume of the minstrel. Volume between 0 and 1 (0.1 = 10%) decides how loud the volume is. If
minstrel can be heard from farther away, while the actual volume will be the same as for 1.0 when close to the NPC. volume is set above 1, it will still only play at full volume (100%), but can be heard further away.
- force update - Whether to forcefully stop and start the minstrel's playlist to make the change happen instantly. - force update - Whether to forcefully stop and start the minstrel's playlist to make the change happen instantly.
### /minstrel pitch ### /minstrel pitch