https://github.com/aoijs/aoi.music

Addition of the Music properties and foundation for aoi.js
https://github.com/aoijs/aoi.music

akarui aoijs discord music

Last synced: about 1 month ago
JSON representation

Addition of the Music properties and foundation for aoi.js

• Host: GitHub
• URL: https://github.com/aoijs/aoi.music
• Owner: aoijs
• License: apache-2.0
• Created: 2021-11-04T22:30:14.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T22:26:05.000Z (4 months ago)
• Last Synced: 2024-08-25T12:09:11.932Z (4 months ago)
• Topics: akarui, aoijs, discord, music
• Language: TypeScript
• Homepage: https://akaruidevelopment.github.io/music/
• Size: 3.79 MB
• Stars: 14
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



@aoijs/aoi.music


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

## 🚀 Setup

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

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

   ```bash

   npm install @aoijs/aoi.music

   ```

2. Import the Manager class and create a new instance:

   ```javascript

   const { Manager } = require("@aoijs/aoi.music");

   

   const manager = new Manager({

      devOptions: {

         debug: false, // Set to true for debugging purposes

      },

      searchOptions: {

         soundcloudClientId: "",

         youtubeAuth: true, // Options: TRUE or FALSE, default: TRUE

         youtubegl: "", // default: US

         youtubeClient: "WEB", // Options: "WEB" | "ANDROID" | "YTMUSIC_ANDROID" | "YTMUSIC" | "YTSTUDIO_ANDROID" | "TV_EMBEDDED", default: WEB

      },

      requestOptions: {

         offsetTimeout: 1500, // Timeout in milliseconds for searching and skipping, default: 500

         soundcloudLikeTrackLimit: 10, // Limit the number of liked tracks from SoundCloud, default: -1

         youtubePlaylistLimit: 20, // Limit the number of tracks in a YouTube playlist, default: -1

         spotifyPlaylistLimit: 30, // Limit the number of tracks in a Spotify playlist, default: -1

      },

   });

   ```

## 📚 Documentation

If you're using aoi.js, you may check [the documentation to learn more here](https://aoi.js.org/extensions/aoi.music/aoimusic-introduction).

Otherwise you can check [these autogenerated docs](https://aoijs.github.io/aoi.music/)