zairullahdev / uzox

The Official Open Source Repository For Uzox, A Discord Music Bot With Over A Million Users

Home Page:https://uzox.xyz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

A Discord Music Bot

Please note that this code is not even with the main source code of Uzox and includes major changes.
This code may not be as efficient, but you can make it! Check the contributing section of this readme.

Logo

Installation

First, fork the repository to your account.

Then clone the repository to your computer

git clone https://github.com/your-username/uzox

Install the required packages with NPM (Must have the Latest NodeJS Version installed)

npm i

Open the config.json file in the config folder and fill out the fields accordingly.

Once you have filled all the fields including the Lavalink server info you can start the bot and it will work! (If you don't know what that is, read the note below) The bot is presharded :)

npm start

Note: Lavalink servers are JAR files which should be hosted on a server or locally on your computer to actually play tracks.

To download it go to the Official CI server and download the Lavalink.jar file.

You also need to configure the Lavalink server with an application.yml file in the same directory as your JAR. There is a premade one in the resources folder which will work without any issues.

You can get the full version of Uzox hosted by us completely for a very low price at our Patreon page!

Contributing

Contributions are always welcome! And please read this before contributing. https://opensource.guide/how-to-contribute/

Authors

License

MIT

MIT License

Copyright (c) 2021 Uzox

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

The Official Open Source Repository For Uzox, A Discord Music Bot With Over A Million Users

https://uzox.xyz

License:MIT License


Languages

Language:JavaScript 100.0%