a music bot because i got bored and made one
the concept is a decentralized music bot.
no instance of this stores any of your data in the filesystem, everything that is stored on filesystem will be stored on the user's filesystem and not the host machine.
the only data that gets stored is a cache of song data, for faster song/playlist adding and paging.
started in december 2022, this is one of the projects i've been working on the longest.
if you encounter any problems or have any suggestions, open an issue.
the queue system this uses is custom and.. fairly different from other queue systems i've seen
instead of simply being an array of name-url objects (atleast what i used in my initial version), it's basically a queue of mini-queues
each item in the queue is either a single track or an entire playlist.
this means if you want to add a playlist to get your opinion on it, and don't like it, you can just skip the entire thing.
i havent used this much, but it seems a lot better if you don't want a slash-command based bot, and don't want to do more complex setup.
in total all it has is 2 files, the .jar and a file w/ the token. nevermind checked the setup and it's got 2 files and 1 folder now, folder being playlists folder.
YADMB made by TheTipo01 and made with golang instead of ts.
havent tried it out, but it seems interesting, so go check it out!
another bot made with ts. looks pretty cool, is a version of N0rthWestW1nd with only it's music functions.
the template config looks like this:
{
"token": "Bot your-token",
"web_features": false,
"web_editor_port": 5500,
"web_editor_link": "url-anyone-can-access",
"package_manager": {
"install": "npm install",
"uninstall": "npm uninstall",
"list": "npm list"
},
"cache_path": ":memory:",
"expiry_time": "3d",
"check_interval": "1m"
}token - the token for the bot. replace your-token with your bot's token.
web_features - should web features be enabled? this isn't needed unless you're planning to forward the web interface for users.
web_editor_port - the port for the web features.
web_editor_link - the link to the web features.
package_manager - for addons. install is the install command for your package manager, uninstall is the uninstall command for your package manager, and list is the command to list all packages. keep list as is for now.
cache_path - the path to the cache database. :memory: means it's in-memory, but if you want to set it to, say, cache.db in the root directory (where this file is), set it to ./cache.db (this is relative to where you run bot.js from, so if you're one directory above it'll put cache.db one directory above)
expiry_time - how long should cached info be valid for?
check_interval - how often should the bot try to remove invalidated cached data?
installing addons is as simple as putting their provided file or folder into the addons folder, and making sure the bot runs correctly!
addon docs can be found here
simply install all the required packages, change your-token to your bot's token in config.json, and run node dist/bot
to enable logging of more debug-related information, create a file called enableDebugging (no extension) in the root directory
changelog has been moved to changelog.md
if you use pnpm or yarn instead of npm, you'll have to change package_manager.install, uninstall and list in config.json to use the respective variant for your package manager
-
you can set the volume to whatever (yes, this means you can destroy your friend's eardrums)
-
you can add an entire playlist or channel
-
add songs from youtube, soundcloud and deezer
- you can add songs from more services with addons
-
can create custom playlists
- these playlists are saved on your pc, with each playlist being its own file formatted as (username).playlist.(playlist name).export.txt, meaning you don't have to rely on the bot to save it in a reliable manner and it works across multiple instances of the bot
-
edit custom playlists
-
export the entire queue or playlist
- like the queue you currently have? just export it!
-
import an exported queue or custom playlist
-
loop the song, playlist or queue
-
a progress command that gives you time left, total duration, author, likes and views for current song
-
search for anything on youtube as long as it's not age-restricted
-
skip individual songs or an entire playlist
-
view a snapshot of the queue
-
make addons if you want support for other services
-
caches data about playlists and songs so adding them again doesn't take as long.
- they have a configurable expiry date, so the database doesnt get too big