npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

naoko-player

v0.0.1

Published

A standard and simple music library for discord.js

Downloads

8

Readme

naoko-player

A standard and simple music library for discord.js NaokoPlayer

How to use

You can download this from github repo

npm i https://github.com/KairoKunazuki/NaokoPlayer.git

NPM

npm i naoko-player

Initializing in your client

const NaokoPlayer = require('naoko-player');
const path = require("node:path");
const MusicManager = new NaokoPlayer.MusicManager({
    providers: [
        new NaokoPlayer.Providers.LocalProvider() // A provider searches in your computer files
    ], // Adding providers
    cacheEnabled: true // Allows music caching
});

Search Music

For searching music, providers have implemented the function Provider.loadTracks to query tracks.

const { LoadResultType } = require('naoko-player').enums;
const provider = MusicManager.providers.get(/* providerName */ 'local') // Find a provider with prefix of 'local', LocalProvider

provider.loadTracks(path.join(process.cwd(), 'NeverGonna.mp3'), /* Filter only tracks / songs */ LoadResultType.Tracks).then(console.log);

Playing Music

Playing music in a server requires an instance of MusicNode. You can create one with MusicManager;

// In Asynchronous
// Connecting to voice channel
MusicManager.joinVoiceChannel({
    channelId: voiceChannel.id,
    guildId: voiceChannel.guild.id,
    adaptorCreator: voiceChannel.guild.voiceAdaptorCreator
});
// Creating the music node for server
const MusicNode = MusicManager.createNode(message.guild.id);
// Loading track
const track = await provider.loadTracks(path.join(process.cwd(), 'NeverGonna.mp3'));
MusicNode.playTrack(track); // Playing track

Providers

Provider.provider

string - The name / prefix of Provider constructor.

Provider.cacheIsAllowed

string - The allowance for caching to tracks loaded from current Provider.

Provider.loadTracks

Usage: Provider.loadTracks(query: string, loadType: LoadResultType): Promise<SearchResultType> Loads and search for tracks.

Params:

  • query - A query string for searching tracks
  • loadType - Load result type for filtering return types.

Provider.getTrackStream

Usage: Provider.getTrackStream(track: ITrack): Promise<stream.Readable> Returns a node:stream.Readable of audio from track

Params:

  • track - The track information from a provider instance