|
1 | 1 | # Muser
|
2 |
| -A powerful Discord music bot managed by PGamerX, Peiprjs and Luckie |
| 2 | + |
| 3 | +A powerful Discord music bot managed by [PGamerX](https://github.com/pgamerx), [Peiprjs](https://github.com/Peiprjs) and [Luckie](https://github.com/Luckie6313) |
| 4 | + |
| 5 | +## Setup |
| 6 | + |
| 7 | +1. Add the bot by clicking [here](https://top.gg/bot/763418289689985035) |
| 8 | + |
| 9 | +2. Make sure the bot has the following permissions |
| 10 | + |
| 11 | +[](https://media.discordapp.net/attachments/767438285562970113/908347703942082600/unknown.png?width=321&height=365) |
| 12 | + |
| 13 | +## Commands |
| 14 | + |
| 15 | +- `/play` - Plays song/playlist from name/url |
| 16 | + |
| 17 | +- `/seek` - Seek to a specific part in the song |
| 18 | + |
| 19 | +- `/pause` - Pauses the current playing song |
| 20 | + |
| 21 | +- `/autoplay` - Disables/Enables autoplay mode |
| 22 | + |
| 23 | +- `/resume` - Resumes the current playing song |
| 24 | + |
| 25 | +- `/volume` - Set volume for the music |
| 26 | + |
| 27 | +- `/filters` - Apply filter(s) on songs |
| 28 | + |
| 29 | +- `/shuffle` - Shuffles the queue |
| 30 | + |
| 31 | +- `/queue` - Displays the current queue |
| 32 | + |
| 33 | +- `/skip` - Skips the current song in the playlist |
| 34 | + |
| 35 | +- `/stop` - Stops playing and deletes the queue |
| 36 | + |
| 37 | +## Self-Hosting |
| 38 | + |
| 39 | +1. Clone the repository using |
| 40 | + |
| 41 | +```sh |
| 42 | + |
| 43 | +git clone https://github.com/PGamerX-Legacy/muser.git |
| 44 | + |
| 45 | +``` |
| 46 | + |
| 47 | +2. install dependencies using |
| 48 | + |
| 49 | +```sh |
| 50 | + |
| 51 | +npm install |
| 52 | + |
| 53 | +``` |
| 54 | + |
| 55 | +3. Add all important credentials in `example.env` |
| 56 | + |
| 57 | +4. Rename `example.env` to `.env` |
| 58 | + |
| 59 | +5. Run the Bot using node. |
| 60 | + |
| 61 | +## Contribution |
| 62 | + |
| 63 | +1. Create a new [discussion](https://github.com/PGamerX-Legacy/muser/discussions/new) |
| 64 | + |
| 65 | +2. Read [CONTRIBUTING.md](https://github.com/PGamerX-Legacy/muser/blob/production/CONTRIBUTING.md) |
| 66 | + |
| 67 | +3. Create a new branch for your feature |
| 68 | + |
| 69 | +4. Commit changes to that branch |
| 70 | + |
| 71 | +5. Create a [Pull Request](https://github.com/PGamerX-Legacy/muser/compare) |
| 72 | + |
| 73 | +If you are new to github, see [how to contribute](https://github.com/firstcontributions/first-contributions) |
| 74 | + |
| 75 | +## License |
| 76 | + |
| 77 | +[AGPL-3.0 License](https://www.gnu.org/licenses/agpl-3.0.en.html) |
0 commit comments