Skip to content

Commit

Permalink
readme: redesign the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nikosszzz committed Feb 24, 2024
1 parent 8f25070 commit c5e8f87
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 34 deletions.
19 changes: 0 additions & 19 deletions CONTRIBUTING.md

This file was deleted.

44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# Music Bot
GitHub Repository of Music Bot.
# <center> Music Bot </center>
<center>🎵⚡ A fast and easy to use Discord.JS 14 music bot that supports YouTube, Spotify and SoundCloud sources to play music off! ⚡🎵</center>
<br>

(The bot's music system was made using source from [eritislami/evobot](https://github.com/eritislami/evobot) with my changes and using the codebase of my own bot Infinium combined. Thank them for the amazing music system.)
<center>
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/nikosszzz/musicbot?style=flat-square&label=🌟 Stars&labelColor=3c3836&color=1d2021">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/nikosszzz/musicbot?style=flat-square&label=🔗 Forks&labelColor=3c3836&color=1d2021">
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/nikosszzz/musicbot?style=flat-square&label=⚠️ Issues&labelColor=3c3836&color=1d2021">
<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/t/nikosszzz/musicbot/main?style=flat-square&label=🧾 Commits&labelColor=3c3836&color=1d2021">
</center>

Support can also be given in Infinium's support discord here: https://discord.gg/QFvCUDydvV
<hr>

## Music Bot Features
## Music Bot Features

YouTube (Key-less API), SoundCloud, Spotify support.
Stable music playback.
Patches from time to time to ensure bot is performing efficiently.
- Playback support for: YouTube, Spotify (with YT Search), SoundCloud
- Fast and optimized music system using play-dl
- Key-less YouTube support
- Slash Commands

## How to run
## How to run

- Install the bot's dependencies (pnpm, npm or whatever you use)
- Run the `build` script
- Run the `bundle.js` output file in the `dist` folder
- Install latest Node.JS LTS and Git.
- Install the bot's dependencies (pnpm, npm or whatever you use).
- Modify the `Bot.ts` and `config.ts` files in `./src/components/` for your bot's configuration.
- Run the `build` script.
- Run the `bundle.js` output file in the `dist` folder.

### Support the development
## 🛠️ Contributions

Send a pull request on here or a issue request so I can help and make Music Bot a better Discord bot.
If you think you can improve Music Bot, please submit a pull request that has well written and efficient code. Slow and poorly written code will be rejected or asked to be re-written properly.

Discord: deoptimize
## 🤝 Support

Submit an issue here in the repository, or join the Infinium Community (My own bot which Music Bot has been based off): https://discord.gg/QFvCUDydvV

## 🌟 Credits
- [eritislami/evobot](https://github.com/eritislami/evobot) for their amazing music system which I adapted with some personal changes.

0 comments on commit c5e8f87

Please sign in to comment.