2.4.0 • Published 2 months ago

@akarui/aoi.music v2.4.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

@akarui/aoi.music is a powerful TypeScript-based JavaScript library that adds music-related properties and lays a solid foundation for music operations in aoi.js.

Whether you're building a music streaming app, a Discord bot with music capabilities, or any other music-related project, @akarui/aoi.music is here to make your life easier!

🚀 Setup

To get started with @akarui/aoi.music, follow these simple steps:

  1. Install @akarui/aoi.music via npm:

    npm install @akarui/aoi.music
  2. Import the Manager class and create a new instance:

    const { Manager } = require("@akarui/aoi.music");
    
    const manager = new Manager({
       devOptions: {
          debug: true, // Set to true for debugging purposes
       },
       searchOptions: {
          soundcloudClientId: "<YOUR_SOUNDCLOUD_CLIENT_ID>",
          youtubeCookie: "<YOUR_YOUTUBE_COOKIE>",
          youtubeAuth: "<YOUR_YOUTUBE_AUTH_PATH>",
          youtubegl: "<YOUR_YOUTUBE_COUNTRY_CODE>",
          youtubeClient: "WEB", // Options: "WEB", "ANDROID", "YTMUSIC"
       },
       requestOptions: {
          offsetTimeout: 10000, // Timeout in milliseconds for searching and skipping
          soundcloudLikeTrackLimit: 10, // Limit the number of liked tracks from SoundCloud
          youtubePlaylistLimit: 20, // Limit the number of tracks in a YouTube playlist
          spotifyPlaylistLimit: 30, // Limit the number of tracks in a Spotify playlist
       },
    });

📚 Documentation

For detailed information on how to use @akarui/aoi.music, check out our documentation. It contains comprehensive guides and examples to help you make the most out of this library.