diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..f80c361 --- /dev/null +++ b/LICENCE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021-present unknowableshade + +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. diff --git a/README.md b/README.md index fe71799..bd5c617 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,51 @@ -# NodejsConsoleApp1 +# 5a0b - 2110.1 +Python discord bot. + +**Since discord.py has been archived and probably will be deprecated. This repo does the same.** +## Latest update +- learn adapt overcome. + +## Features + +### Music player + +- Play music from YouTube and other supported platforms +- *Create your queues and save them* [**Deprecated**] +- Loop queue, song. +- Play next, stop, pause, resume. +- Queue jump, remove. +- And another features. + +## Installation + +### Download bot repository + +- **[Download](https://github.com/unknowableshade/5a0b-bot/archive/refs/heads/master.zip)** + +### Requirements + +> :warning: **Read the docs!** + +- **Install** [nodejs](https://nodejs.org/en/download/) + +- **Install** required libraries: + +```bash +$ npm install +``` + +- **Install** [ffmpeg](https://www.ffmpeg.org/download.html) + +### Bot startup + +- **Insert** bot token in main.py file + +- **Build** via typescript compiller + +- **Start** ./dist/app.js + +## Licence + +**[Licence](https://github.com/unknowableshade/5a0b-bot/blob/master/LICENSE)**