Melody/README.md
2024-01-23 19:24:47 +00:00

93 lines
5.6 KiB
Markdown

<p align="center">
<img src="https://i.imgur.com/phFnOFf.png" />
</p>
<h1 align="center">Melody</h1>
<p align="center">Feature-full Discord music bot supporting YouTube, Spotify, SoundCloud, and many other sites.</p>
<p align="center">
<a href="https://github.com/NerdyTechy/Melody/actions">
<img alt="Tests Passing" src="https://github.com/NerdyTechy/Melody/workflows/CodeQL/badge.svg" />
</a>
<a href="https://github.com/NerdyTechy/Melody/graphs/contributors">
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/NerdyTechy/Melody" />
</a>
<a href="https://github.com/NerdyTechy/Melody/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/NerdyTechy/Melody" />
</a>
<a href="https://github.com/NerdyTechy/Melody/blob/master/LICENSE">
<img alt="Issues" src="https://img.shields.io/github/license/NerdyTechy/Melody" />
</a>
<a href="https://github.com/NerdyTechy/Melody/pulls">
<img alt="Issues" src="https://img.shields.io/github/issues-pr-closed/NerdyTechy/Melody" />
</a>
<a href="https://github.com/NerdyTechy/Melody/commits">
<img alt="Issues" src="https://img.shields.io/github/last-commit/NerdyTechy/Melody" />
</a>
<a href="https://github.com/NerdyTechy/Melody"><img alt="Statistics Graphs" src="https://repobeats.axiom.co/api/embed/966fb1f700b2ca070b73426ccafcc5dd2b7576fb.svg"></a>
</p>
<h2>About Melody</h2>
Melody was originally developed because the best music bots shut down, and most alternatives had core features such as effects locked behind a paywall. Melody started as a bot that was just used in a server with some friends and then became a project that I released publicly for anyone to use and maintain.
<h2>Features</h2>
Melody is a feature-rich Discord music bot. It offers a clean look, easy-to-use commands, and active development. Check out the list below for a full list of features:
<br>
<br>
<ul>
<li>Easy installation</li>
<li>Multi-server support</li>
<li>Genius song lyrics integration</li>
<li>Volume controller</li>
<li>Full player control with pausing, seeking, and volume control</li>
<li>Queue support with skipping, returning to the previous song, viewing queued songs, queue shuffling, queue clearing, adding songs to the end of the queue, or the next position in the queue</li>
<li>Listening statistics that allow you to see how many songs you've listened to, how many songs you've skipped, and how many times you've shuffled the queue</li>
<li>Saving songs to your direct messages for you to refer back to later</li>
<li>20+ effects to spice up your music</li>
<li>Search autocomplete</li>
<li>Support for YouTube, Spotify, SoundCloud, and many more</li>
<li>Playlist integration that allows play-shuffling and looping</li>
</ul>
<h2>Screenshots</h2>
<p align="center">
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/1.png" width="500px" />
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/2.png" width="500px" />
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/3.png" width="500px" />
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/4.png" width="500px" />
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/5.png" width="500px" />
<img src="https://raw.githubusercontent.com/NerdyTechy/Melody/master/assets/screenshots/6.png" width="500px" />
</p>
<h2>Installation</h2>
For a detailed installation guide, check out our <a href="https://github.com/NerdyTechy/Melody/wiki/Installation">Installation Wiki page</a>.
<h2>Analytics</h2>
By default, Melody tracks basic anonymous analytics when you start up the bot. To disable this, set the `enableAnalytics` option in the configuration file to **false**. To learn more about the analytics Melody sends, <a href="https://github.com/NerdyTechy/Melody/wiki/Analytics">click here</a>.
<h2>Genius</h2>
Melody utilises Genius' API to find lyrics for songs. A Genius API key isn't required to use the bot but will make the lyrics feature far more reliable. Obtaining one is free, and can be done so <a href="https://genius.com/api-clients">here</a>.
<h2>Hosting</h2>
Want to host this bot online? Any hosting company that provides Discord bot hosting (or VPS hosting if you know what you're doing) will work, but I highly recommend <a href="https://techy.lol/revivenode">Revivenode</a> (Affiliate Link).
<h2>Like Melody?</h2>
There are many ways you can support Melody and its development. One of the best ways that you can support the project is by starring it. It's free and really helps out. Other than that, you can support Melody's development by using my [Revivenode affiliate link](https://techy.lol/revivenode) which will give me a small percentage of what you spend at Revivenode, without charging you anything extra, or you can donate directly to me via [GitHub Sponsors](https://github.com/sponsors/NerdyTechy) or [buymeacoffee.com](https://www.buymeacoffee.com/techy). All donations are highly appreciated! <3
<h2>My Other Projects</h2>
If you like Melody, you might like some of my other projects as well! Check out my <a>profile</a> to see what else I'm working on, and consider following me to support my work!
<h2>Star History</h2>
<img src="https://api.star-history.com/svg?repos=NerdyTechy/Melody&type=Date">
<h2>Contributors</h2>
<a href = "https://github.com/NerdyTechy/Melody/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=NerdyTechy/Melody"/>
</a>
<br>
Want to appear here? Contribute to Melody via a pull request and if your changes get merged you'll appear here automatically! Thanks for contributing <3