Installation & Setup
This page will go over the installation & setup process to get MusePluse running on your 1.19+ Minecraft Server!
Installing MusePluse is a straightforward process similar to other plugins. To get started, just place the plugin file in your /plugins folder and then restart your server. However, before you can fully utilize the plugin, there are some essential setup steps you need to follow.
The primary requirement is to ensure that port 25572 (This may be changed in the settings.yml) is open before starting the server. If you'd like a more detailed understanding of the entire startup process and additional configuration options, please refer to the information provided below.
If your MusePluse installation appears to be "hanging" or "frozen", stop your server, and delete the /plugins/MusePluse folder and try again. Sometimes YouTube may hiccup and not full send your server the video data. If the hanging happens when downloading the songs you may simply /reloadmusepluse instead of restarting the server! Alternatively, if there is an error with a specific song that you see (Happens when YouTube blocks a video, shouldn't happen often!). You have 2 options 1) Completely removing the errored song from songs.yml, deleting all folders except "ffmpeg" and restarting your server. 2) You can simply find a link to the video that will work for you and replace it in the songs.yml (Considering this error is with a default song). Delete all folders except "ffmpeg", and restart your server!
When you launch MusePluse for the first time, you might notice that it generates several messages. There's no need to worry! The plugin relies on https://ffmpeg.org/about.html to convert downloaded YouTube videos into the OGG format. This format is the only one supported by resource packs for music in Minecraft versions 1.19 and above.
In addition to managing the FFmpeg installation, MusePluse automatically creates a resource pack. The initial run may be verbose, but you can be assured that MusePluse won't inundate your console with messages thereafter.
Please note that removing the logs is not currently possible as the framework is still under development. The logs serve the purpose of debugging and troubleshooting any issues you may encounter.
While MusePluse is running its installation process, you can join and play on your server without any issues, even as the resource pack is being built. However, it's essential to set up how you'll host the resource pack for your players. Fortunately, MusePluse provides a seamless in-house solution just for that!
Once the resource pack is created, you'll need a method to distribute it to the players on your server. Refer to the documentation below for instructions on how to set it up.
Setting up the embedded resource pack server
By default, MusePluse is configured to automatically host the resource pack. However, this feature requires you to open port 25572 on your server. You may change this in the settings.yml configuration file in the ResourcePackServer section labeled as Port!
And that's it! Voila! For the best experience, we recommend opening the port before adding MusePluse to your server
Hosting the resource pack yourself
If you don't want to use the embedded resource pack server for whatever reason (There really isn't). MusePluse offers an option to do it yourself! Simply provide a direct resource pack link in the settings.yml in the ResourcePack field. From there, go down to the ResourcePackServer and set Enabled to false
After the server starts wait until console tells your the resource pack has been created, it will be accesible in /plugins/MusePluse/resource-pack for you to take and host on a site like dropbox/github
Last updated
