Installation
Quick Installation
Last updated
Quick Installation
Last updated
If you are not using xsound
or interact_sounds
just start the surround and you are done.
Put your sound files you use in xsound
or interact-sound
into mx-surround/ui/sounds
Remove xsound
and interact-sound
from your server
Start your server and enjoy it
Don't make the script name xsound
or interact-sound
. Keep it as mx-surround
and use that. You don't need to change export names or anything like that!
Don't forget to download mx-audioplayer. It will provide you a dj, car radio and a good looking user interface.
THIS STEP IS ONLY FOR PEOPLE WHO WANT TO BUILD THEIR OWN API. WHEN YOU BUY SURROUND THE API IS ALREADY PROVIDED BY US SO YOU DON'T NEED TO DO ANYTHING.
You can download it from discord. Its not given in the keymaster. After the installation follow the instructions on the below
Go to api/build
and run the api.exe
If you want to move the api another location, make sure you get the api folder directly. Do not just take the exe
You need to use nodejs. You can find the source code in the api/src/
I recommend using pm2, it's easier to monitor
If you want to run the api on another server, add the ip address or domain of the remote server to Config.Endpoint
If you are using a domain, don't forget to set Config.EndpointPort
to false
The song cache limit is set to 500 by default. This corresponds to an area of 3gb. The higher the cache limit, the less songs you download from youtube and the less chance of being blocked, so be careful not to set it to low values.
Scripts using old xsound scripts such as gcphone, gks-phone are not supported. If you use such scripts, make sure to switch off the xsound provider of mx-surround. Otherwise the api will blacklist you.
DO NOT use prepare export for songs that you have extracted from the website. The API will block you again. Prepare export should only be executed once. Not all clients should run prepare export
interact-sound
is fully provided.
xsound
is fully provided for server side usages. If you are using it on the client side with local audios it will work like a charm. But if the code uses youtube links it will probably throw "do not spam prepare export" to solve this you need to check prepare export usage and need to adapt it to your xsound script.