Merge pull request #1945 from Androz2091/rewrite-hooks

refactor: rewrite hooks and remove youtube

README.md

@@ -86,28 +86,6 @@ $ npm install --save ffmpeg-binaries
 
 > Use `FFMPEG_PATH` environment variable to load ffmpeg from custom path.
 
-#### Streaming Library
-
-**The following method is deprecated and will be removed in the future. Please switch to [discord-player-youtubei](https://npmjs.com/discord-player-youtubei).**
-
-**Not recommended**:
-
-YouTube streaming is not supported without installing one of the following package. If you want to add support for YouTube playback, you need to install a streaming library. This step is not needed if you do not plan on using youtube source.
-
-```bash
-$ npm install --save youtube-ext
-# or
-$ npm install --save play-dl
-# or
-$ npm install --save @distube/ytdl-core
-# or
-$ npm install --save yt-stream
-# or
-$ npm install --save ytdl-core
-```
-
-Once you have completed these installations, let's proceed with writing a simple music bot.
-
 ### Setup
 
 Let's create a main player instance. This instance handles and keeps track of all the queues and its components.
@@ -147,13 +125,31 @@ const { Player, createErisCompat } = require('discord-player');
 const player = new Player(createErisCompat(client));
 ```
 
+Before you add the command, make sure to provide the context to the commands if you wish to use discord-player's hooks (like `useMainPlayer`).
+
+### Before
+
+```js index.js
+// execute the command
+await command.execute(interaction);
+```
+
+### After
+
+```js index.js
+// execute the command
+await player.context.provide({ guild: interaction.guild }, () => command.execute(interaction));
+```
+
+This allows discord-player to automatically know the current guild and the queue, resulting in cleaner code and seamless integration. This eradicates the need to pass the player instance to the command or use hacks like `client.player = player`.
+
 Let's move on to the command part. You can define the command as per your requirements. We will only focus on the command part:
 
 ```js play.js
 const { useMainPlayer } = require('discord-player');
 
 export async function execute(interaction) {
-    const player = useMainPlayer();
+    const player = useMainPlayer(); // get player instance
     const channel = interaction.member.voice.channel;
     if (!channel) return interaction.reply('You are not connected to a voice channel!'); // make sure we have a voice channel
     const query = interaction.options.getString('query', true); // we need input/query to play

apps/docs/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "git+https://github.com/Androz2091/discord-player.git"
   },
-  "author": "twlite <[email protected]>",
+  "author": "Twilight <[email protected]>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/Androz2091/discord-player/issues"

apps/eris-bot/package.json

@@ -3,11 +3,11 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
-    "start": "tsx src/index.ts"
+    "start": "tsx --env-file=.env src/index.ts"
   },
   "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "author": "Twilight <[email protected]>",
+  "license": "MIT",
   "description": "",
   "devDependencies": {
     "@types/node": "^22.2.0",

apps/eris-bot/src/index.ts

@@ -1,5 +1,4 @@
 /* eslint-disable no-console */
-import 'dotenv/config';
 import Eris from 'eris';
 import { Player, createErisCompat } from 'discord-player';
 

apps/music-bot/package.json

@@ -1,50 +1,23 @@
 {
   "name": "music-bot",
   "version": "1.0.0",
-  "main": "dist/index.js",
-  "author": "Androz2091 <[email protected]>",
-  "license": "MIT",
-  "dependencies": {
-    "@discord-player/equalizer": "workspace:^",
-    "@discord-player/extractor": "workspace:^",
-    "@discord-player/utils": "workspace:^",
-    "@discordjs/opus": "^0.9.0",
-    "@distube/ytdl-core": "^4.13.3",
-    "@sapphire/discord.js-utilities": "^6.0.3",
-    "@sapphire/duration": "^1.0.0",
-    "@sapphire/framework": "^4.2.1",
-    "@sapphire/plugin-api": "^5.0.1",
-    "@sapphire/plugin-hmr": "^2.0.0",
-    "@sapphire/plugin-logger": "^3.0.1",
-    "@skyra/env-utilities": "^1.1.0",
-    "colorette": "^2.0.19",
-    "discord-api-types": "^0.37.35",
-    "discord-player": "workspace:^",
-    "mediaplex": "^0.0.9",
-    "opusscript": "^0.0.8",
-    "play-dl": "^1.9.7",
-    "youtube-ext": "^1.1.23"
+  "description": "Test music bot",
+  "main": "src/index.ts",
+  "type": "module",
+  "scripts": {
+    "start": "tsx --env-file=.env ./src/index.ts"
   },
-  "devDependencies": {
-    "@sapphire/prettier-config": "^1.4.5",
-    "@sapphire/ts-config": "^3.3.4",
-    "@swc/cli": "^0.1.62",
-    "@swc/core": "^1.3.37",
-    "@types/node": "^18.14.6",
-    "@types/ws": "^8.5.4",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.4",
-    "tsc-watch": "^6.0.0",
-    "tsup": "^7.2.0",
-    "tsx": "^3.12.7",
-    "typescript": "^5.2.2",
-    "vitest": "^0.34.6"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Androz2091/discord-player.git"
   },
-  "scripts": {
-    "build": "tsup",
-    "start": "tsup && node dist/index.js",
-    "dev": "tsx ./src/index.ts",
-    "format": "prettier --write \"src/**/*.ts\""
+  "author": "twilight <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Androz2091/discord-player/issues"
   },
-  "prettier": "@sapphire/prettier-config"
+  "homepage": "https://github.com/Androz2091/discord-player#readme",
+  "devDependencies": {
+    "tsx": "^4.19.2"
+  }
 }