Docs : Added new pages for actions, events & hooks #1676
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
febkosq8
changed the title
twlite
approved these changes
Mar 11, 2023
github-merge-queue bot
pushed a commit
to PixelPizza/OurTube
that referenced
this pull request
Jul 15, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [discord-player](https://discord-player.js.org) ([source](https://togithub.com/Androz2091/discord-player)) | [`^5.4.0` -> `^6.6.1`](https://renovatebot.com/diffs/npm/discord-player/5.4.0/6.6.1) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>Androz2091/discord-player (discord-player)</summary> ### [`v6.6.1`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.6.1) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.6.0...discord-player@6.6.1) #### What's Changed - docs(resource): update flowease's discord-player version in showcase.ts by [@​Lutra-Fs](https://togithub.com/Lutra-Fs) in [Androz2091/discord-player#1755 - Fix typo for userVoiceChannel in the documention by [@​L0SER8228](https://togithub.com/L0SER8228) in [Androz2091/discord-player#1756 - createProgressBar options by [@​chimnayajith](https://togithub.com/chimnayajith) in [Androz2091/discord-player#1757 - feat: introduce BridgeSource by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1760 #### New Contributors - [@​Lutra-Fs](https://togithub.com/Lutra-Fs) made their first contribution in [Androz2091/discord-player#1755 - [@​chimnayajith](https://togithub.com/chimnayajith) made their first contribution in [Androz2091/discord-player#1757 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/[@​discord-player/equalizer](https://togithub.com/discord-player/equalizer)[@​0](https://togithub.com/0).2.2...discord-player@6.6.1 ### [`v6.6.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.6.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.5.0...discord-player@6.6.0) #### What's Changed - docs(resources): add Mirasaki Music Bot by [@​Mirasaki](https://togithub.com/Mirasaki) in [Androz2091/discord-player#1745 - Bump community resource version by [@​Mirasaki](https://togithub.com/Mirasaki) in [Androz2091/discord-player#1748 - 📝 Fix broken URL in document by [@​GreenScreen410](https://togithub.com/GreenScreen410) in [Androz2091/discord-player#1752 - refactor: website rewrite by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1753 - feat: `channelPopulate` and friends #### New Contributors - [@​Mirasaki](https://togithub.com/Mirasaki) made their first contribution in [Androz2091/discord-player#1745 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/[@​discord-player/extractor](https://togithub.com/discord-player/extractor)[@​4](https://togithub.com/4).3.1...discord-player@6.6.0 ### [`v6.5.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.5.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.4.0...discord-player@6.5.0) ### Changelog - fix(QueryResolver): spotify playlists were treated as youtube playlists - feat(GuildQueueEvents): add `willPlayTrack` event - types(GuildQueueEvent): make events constant usable in event listener - feat(GuildQueue): expose `maxSize` and `maxHistorySize` - feat(GuildQueue): add `options.preferBridgedMetadata` - fix(Track): resolve `null` upon metadata query failure - feat(GuildQueuePlayerNode): add `.totalDuration` getter - feat(GuildQueuePlayerNode): implement `StreamConfig` ##### Example of `willPlayTrack` event ```ts // listening to this event pauses discord-player's execution process until `done()` is invoked player.events.on(GuildQueueEvent.willPlayTrack, (queue, track, config, done) => { // set volume to 30% config.dispatcherConfig.volume = 30; // seek to 20 seconds before playing config.playerConfig.seek = 20; // tell discord-player to resume execution process return done(); }); ``` **Full Changelog**: https://github.com/Androz2091/discord-player/compare/[@​discord-player/extractor](https://togithub.com/discord-player/extractor)[@​4](https://togithub.com/4).3.0...discord-player@6.5.0 ### [`v6.4.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.4.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.3.1...discord-player@6.4.0) #### What's Changed - feat: track metadata api - fix: spotify regex - feat: bridge query resolver - feat: track metadata api - feat: introduce play method on tracks and queues - feat: allow audio player options on play method - feat: error codes - Update my community bot version and description by [@​L0SER8228](https://togithub.com/L0SER8228) in [Androz2091/discord-player#1742 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/discord-player@6.3.1...discord-player@6.4.0 ### [`v6.3.1`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.3.1) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.3.0...discord-player@6.3.1) #### What's Changed - fix(FFmpeg): unexpected error from ffmpeg locator - feat(PlayerInitOptions): add `useFFmpegLegacy` option to utilize `prism-media`'s ffmpeg - Update community bot Music-Disc version by [@​hmes98318](https://togithub.com/hmes98318) in [Androz2091/discord-player#1737 - Added my bot by [@​L0SER8228](https://togithub.com/L0SER8228) in [Androz2091/discord-player#1739 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/[@​discord-player/extractor](https://togithub.com/discord-player/extractor)[@​4](https://togithub.com/4).2.2...discord-player@6.3.1 ### [`v6.3.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.3.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.2.1...discord-player@6.3.0) #### What's Changed - feat: add custom ffmpeg implementation (supporting more ffmpeg binaries) - fix: proper validation for leaveOnEnd - fix(Player): set query cache properly by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1721 - Update Docs to reflect autoRegisterExtractor depreciation by [@​febkosq8](https://togithub.com/febkosq8) in [Androz2091/discord-player#1722 - feat: implement custom ffmpeg stream by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1723 - \[DOCS-FIX] Update version of community bot by [@​Mittelblut9](https://togithub.com/Mittelblut9) in [Androz2091/discord-player#1720 - docs: update version botanique by [@​Mylloon](https://togithub.com/Mylloon) in [Androz2091/discord-player#1724 - docs: add wego overseer to community resources by [@​rickklaasboer](https://togithub.com/rickklaasboer) in [Androz2091/discord-player#1727 #### New Contributors - [@​Mittelblut9](https://togithub.com/Mittelblut9) made their first contribution in [Androz2091/discord-player#1720 - [@​Mylloon](https://togithub.com/Mylloon) made their first contribution in [Androz2091/discord-player#1724 - [@​rickklaasboer](https://togithub.com/rickklaasboer) made their first contribution in [Androz2091/discord-player#1727 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/discord-player@6.2.1...discord-player@6.3.0 ### [`v6.2.1`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.2.1) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.2.0...discord-player@6.2.1) ### Changelog - fix esm build **Full Changelog**: https://github.com/Androz2091/discord-player/compare/discord-player@6.2.0...discord-player@6.2.1 ### [`v6.2.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.2.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.1.1...discord-player@6.2.0) #### What's Changed - Add `interaction.guild` for player.nodes.create by [@​TapsHTS](https://togithub.com/TapsHTS) in [Androz2091/discord-player#1689 - Add fullTitle property to LyricsExtractor by [@​Crocross](https://togithub.com/Crocross) in [Androz2091/discord-player#1690 - Add Beat-Bot to community bots by [@​IslandRhythms](https://togithub.com/IslandRhythms) in [Androz2091/discord-player#1701 - update references of 'karasu-music-bot' to 'auricle-music-bot' by [@​itsauric](https://togithub.com/itsauric) in [Androz2091/discord-player#1703 - Add Melody to community resources docs page by [@​NerdyTechy](https://togithub.com/NerdyTechy) in [Androz2091/discord-player#1704 - Update community bot Music-disc module version by [@​hmes98318](https://togithub.com/hmes98318) in [Androz2091/discord-player#1711 - added link to DumBot within community resources by [@​Mateo-Wallace](https://togithub.com/Mateo-Wallace) in [Androz2091/discord-player#1714 - docs: use yarn in installation examples by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1712 - feat(ExtractorExecutionContext): infer ext initialization options by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1716 - Remove extractors peer dependencies by [@​NotGhex](https://togithub.com/NotGhex) in [Androz2091/discord-player#1718 #### New Contributors - [@​TapsHTS](https://togithub.com/TapsHTS) made their first contribution in [Androz2091/discord-player#1689 - [@​IslandRhythms](https://togithub.com/IslandRhythms) made their first contribution in [Androz2091/discord-player#1701 - [@​hmes98318](https://togithub.com/hmes98318) made their first contribution in [Androz2091/discord-player#1711 - [@​Mateo-Wallace](https://togithub.com/Mateo-Wallace) made their first contribution in [Androz2091/discord-player#1714 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/discord-player@6.1.1...discord-player@6.2.0 ### [`v6.1.1`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.1.1) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/discord-player@6.1.0...discord-player@6.1.1) #### What's Changed - Docs : Added new pages for actions, events & hooks by [@​febkosq8](https://togithub.com/febkosq8) in [Androz2091/discord-player#1676 - refactor(karasu): setup, commands and listeners by [@​itsauric](https://togithub.com/itsauric) in [Androz2091/discord-player#1686 - feat(GuildQueue): move, copy, swap - feat(QueryType): add AUTO_SEARCH type - refactor(QueryResolver): set fallback query to AUTO_SEARCH - refactor(ExtractorExecutionContext): unprioritize youtube extractor **Full Changelog**: https://github.com/Androz2091/discord-player/compare/discord-player@6.1.0...discord-player@6.1.1 ### [`v6.1.0`](https://togithub.com/Androz2091/discord-player/releases/tag/discord-player%406.1.0) [Compare Source](https://togithub.com/Androz2091/discord-player/compare/v6.0.0...discord-player@6.1.0) #### Changelog - fix: use appropriate source for autoplay - feat: add initialization options for extractors - fix: apply requestedBy on search results if available - feat: add extractor events - docs: update music bot status by [@​Nonolanlan1007](https://togithub.com/Nonolanlan1007) in [Androz2091/discord-player#1646 - fix(GuildQueuePlayerNode): patch seek method by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1652 - Fix declaration file not found by [@​NotGhex](https://togithub.com/NotGhex) in [Androz2091/discord-player#1647 - fix(GuildQueuePlayerNode): fix stream error by [@​Abish-x-lethal](https://togithub.com/Abish-x-lethal) in [Androz2091/discord-player#1654 - Update docs for AutoComplete and minor changes by [@​febkosq8](https://togithub.com/febkosq8) in [Androz2091/discord-player#1674 #### New Contributors - [@​Nonolanlan1007](https://togithub.com/Nonolanlan1007) made their first contribution in [Androz2091/discord-player#1646 - [@​NotGhex](https://togithub.com/NotGhex) made their first contribution in [Androz2091/discord-player#1647 - [@​Abish-x-lethal](https://togithub.com/Abish-x-lethal) made their first contribution in [Androz2091/discord-player#1654 - [@​febkosq8](https://togithub.com/febkosq8) made their first contribution in [Androz2091/discord-player#1674 **Full Changelog**: https://github.com/Androz2091/discord-player/compare/v6.0.0...discord-player@6.1.0 ### [`v6.0.0`](https://togithub.com/Androz2091/discord-player/releases/tag/v6.0.0): 6.0.0 [Compare Source](https://togithub.com/Androz2091/discord-player/compare/v5.4.0...v6.0.0) ### BREAKING CHANGES!! >⚠️ \[`semver:major`] This release contains breaking changes, making old codes unusable. Documentation: https://discord-player.js.org Migration Guide: https://discord-player.js.org/docs/guides/v6-migration #### What's Changed - chore: monorepo setup by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1510 - fix(StreamDispatcher): make paused property a getter by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1517 - feat: new docs website by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1530 - Add 'karasu-music-bot' to examples in README.md by [@​itsauric](https://togithub.com/itsauric) in [Androz2091/discord-player#1552 - feat(QueryResolver): apple music user playlists by [@​BasboBibbins](https://togithub.com/BasboBibbins) in [Androz2091/discord-player#1580 - refactor: example commands by [@​itsauric](https://togithub.com/itsauric) in [Androz2091/discord-player#1590 - feat(GuildQueue): add size getter by [@​Crocross](https://togithub.com/Crocross) in [Androz2091/discord-player#1606 - refactor(karasu) by [@​itsauric](https://togithub.com/itsauric) in [Androz2091/discord-player#1607 - Update migrating.md by [@​Crocross](https://togithub.com/Crocross) in [Androz2091/discord-player#1629 - Update migrating.md by [@​Crocross](https://togithub.com/Crocross) in [Androz2091/discord-player#1637 - feat!: discord-player v6 by [@​skdhg](https://togithub.com/skdhg) in [Androz2091/discord-player#1513 - Rewrite of the entire queue system - Rewrite of extractors API - New audio filters API - New Query Cache API - New extractors limitation API - New global shortcuts (hooks, player methods) - Singleton by default - Better stream handling - 2 events dispatcher (Player & Player.events) - Improved debug logs - New lifecycle events - New stream hook (`onAfterCreateStream`) - Various bugfixes to `StreamDispatcher` - New voice receiving feature - Removal of internal extractors - Apple Music support (including search queries) - Addition of Biquad filters, 15 band equalizer (lavalink compatible) & its presets, DSP filters - Stability of audio player - Improved management of audioplayer lifecycle as well as voice connection - Removal of smooth volume - Ability to play raw audio resources - Dynamic duration estimation for tracks - New query resolver types - New documentation - New utils package #### New Contributors - [@​itsauric](https://togithub.com/itsauric) made their first contribution in [Androz2091/discord-player#1552 - [@​BasboBibbins](https://togithub.com/BasboBibbins) made their first contribution in [Androz2091/discord-player#1580 - [@​Crocross](https://togithub.com/Crocross) made their first contribution in [Androz2091/discord-player#1606 **Full Changelog**: Androz2091/discord-player@v5.4.0...v6.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/PixelPizza/OurTube). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNDQuMiIsInVwZGF0ZWRJblZlciI6IjM2LjUuMyIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jaron <60853956+JaronZ@users.noreply.github.com> Co-authored-by: mcpsbot <83839790+mcpsbot@users.noreply.github.com> Co-authored-by: Jaron <jaron_zijlstra@outlook.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Status