Adds some notes about the limitations of this plugin

This commit is contained in:
Kristian Knarvik 2022-10-30 21:11:28 +01:00
parent 386d6492aa
commit 9d7a9117be
2 changed files with 17 additions and 1 deletions

View File

@ -12,3 +12,17 @@ can be heard further away.
## Dependencies
- Citizens
## Important to note
There are limitations connected to directly playing media using playSound:
- There is no way to really know what is playing for a player. The best one can do is track any time a song is played
outside the global cycle.
- When a new player joins there are only two ways to make the music play for the player: Either play immediately, and
cut the song short once the playlist switches songs, or play nothing until the playlist switches songs. None of these
are ideal.
- 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
player outside the global cycle, it shouldn't be too much of a problem, but if several minstrels play the same song,
there may be silent minstrels until the next song plays.

View File

@ -36,6 +36,8 @@ public class MinstrelCommand implements CommandExecutor {
case "volume":
return updateVolume(minstrelTrait, args.length > 1 ? args[1] : null, sender);
}
//TODO: Add another argument for volume and pitch for whether to immediately change the volume by restarting the playlist
/* Sub-commands:
AddSong category identifier duration (remember to run play again)
RemoveSong index