mirror of
https://github.com/pelican-eggs/eggs.git
synced 2025-11-04 02:48:07 +00:00
95 lines
3.8 KiB
Markdown
95 lines
3.8 KiB
Markdown
# JMusicBot
|
|
|
|
___
|
|
|
|
## Authors / Contributors
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/jagrosh">
|
|
<img src="https://avatars.githubusercontent.com/u/12754382" width="50px;" alt=""/><br /><sub><b>John Grosh</b></sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/jagrosh/MusicBot/commits?author=jagrosh" title="Codes">💻</a>
|
|
<a href="https://github.com/jagrosh/MusicBot/commits?author=jagrosh" title="Original Bot Creator">🤖</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/parkervcp">
|
|
<img src="https://avatars.githubusercontent.com/u/1207679" width="50px;" alt=""/><br /><sub><b>parkervcp</b></sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=parkervcp" title="Codes">💻</a>
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=parkervcp" title="Original Egg Creator">🥚</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Software-Noob">
|
|
<img src="https://avatars.githubusercontent.com/u/10975908" width="50px;" alt=""/><br /><sub><b>Software-Noob</b></sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=Software-Noob" title="Codes">💻</a>
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=Software-Noob" title="Contributor">💡</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Proxymiity">
|
|
<img src="https://avatars.githubusercontent.com/u/25194496" width="50px;" alt=""/><br /><sub><b>Proxymiity</b></sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=Proxymiity" title="Codes">💻</a>
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=Proxymiity" title="Contributor">💡</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/lilkingjr1">
|
|
<img src="https://avatars.githubusercontent.com/u/4533989" width="50px;" alt=""/><br /><sub><b>Red-Thirten</b></sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=lilkingjr1" title="Codes">💻</a>
|
|
<a href="https://github.com/parkervcp/eggs/commits?author=iamkubi" title="Contributor">💡</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- markdownlint-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
___
|
|
|
|
## Bot Description & Features
|
|
|
|
From the developer's [Github](https://github.com/jagrosh/MusicBot):
|
|
> A Discord music bot that's easy to set up and run yourself!
|
|
|
|
- Easy to run
|
|
- Fast loading of songs
|
|
- No external keys needed (besides a Discord Bot token)
|
|
- Smooth playback
|
|
- Server-specific setup for the "DJ" role that can moderate the music
|
|
- Clean and beautiful menus
|
|
- Supports many sites, including YouTube, Soundcloud, and more
|
|
- Supports many online radio/streams
|
|
- Supports local files
|
|
- Playlist support (both web/youtube, and local)
|
|
|
|
___
|
|
|
|
## Configuration
|
|
|
|
- If you can, edit the Startup Variables before starting the bot, because otherwise it will fail to start.
|
|
- Most settings found in `config.txt` can be edited via the Startup Variables. Advanced settings not listed can still be edited manually via the File Manager. Available Startup Variables will take precedent over manual edits.
|
|
|
|
___
|
|
|
|
## Server Ports
|
|
|
|
There are no ports required for JMusicBot.
|
|
___
|
|
|
|
## Updating
|
|
|
|
Re-Installing the server via the panel will do the following:
|
|
|
|
1. Update the bot to the latest version.
|
|
2. Update the `config.txt` file to the latest version, and place the old one at `config.txt-old`.
|
|
3. Any local songs will remain and not be touched.
|