Skip to content

Commit

Permalink
refactor!: rewrite DisTubeHandler, add debug event
Browse files Browse the repository at this point in the history
  • Loading branch information
skick1234 committed Jun 4, 2024
1 parent eef39c6 commit 535ef4b
Show file tree
Hide file tree
Showing 24 changed files with 1,578 additions and 2,134 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

**The issue tracker is only for bug reports. If you have a question or an enhancement suggestion, please post it in [GitHub Discussions (preferred)](https://github.com/skick1234/DisTube/discussions) or the [DisTube Support Server](https://discord.gg/feaDd9h) instead of opening an issue.**
**The issue tracker is only for bug reports. If you have a question or an enhancement suggestion, please post it in the [DisTube Support Server](https://discord.gg/feaDd9h) instead of opening an issue.**

If you wish to contribute to DisTube, feel free to fork the repository and submit a pull request.

Expand Down
5 changes: 1 addition & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ contact_links:
- name: Frequently Asked Questions
url: https://github.com/skick1234/DisTube/wiki/Frequently-Asked-Questions
about: DisTube Frequently Asked Questions
- name: Discussions
url: https://github.com/skick1234/DisTube/discussions
about: Suggest an idea for this project or ask a question here
- name: Discord Support Server
url: https://discord.gg/feaDd9h
about: Like Discussions but on Discord
about: Suggest an idea for this project or ask a question here on Discord
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,19 @@ A powerful Discord.js module for simplifying music commands and effortless playb

## Features

- Built on top of [discord.js](https://discord.js.org) v14 and [@discordjs/voice](https://discord.js.org)
- Easy to use and customize
- Queue management
- Audio filters
- Auto-play related songs
- Plugin system for supporting numerous music sources
- Easy Integration: Built on top of [discord.js](https://discord.js.org) v14 and [@discordjs/voice](https://discord.js.org).
- Voice and Queue Management: Handles voice channel connections, disconnections, and manages music queues efficiently.
- Audio Filters: Offers built-in audio filters (bassboost, echo, karaoke, etc.) and allows for custom filter implementations.
- Plugin System: Supports extensibility through plugins
> DisTube by default doesn't support any music sources. You have to use plugins to support them.
## Requirement

- Node.js 18.17.0 or higher
- [discord.js](https://discord.js.org) v14
- [@discordjs/voice](https://github.com/discordjs/voice)
- [FFmpeg](https://www.ffmpeg.org/download.html)
- [@discordjs/opus](https://github.com/discordjs/opus)
- [FFmpeg](https://www.ffmpeg.org/download.html)
- [sodium-native](https://www.npmjs.com/package/sodium-native)

## Documentation
Expand Down
40 changes: 19 additions & 21 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "distube",
"version": "4.2.2",
"description": "A Discord.js module to simplify your music commands and play songs with audio filters on Discord without any API key.",
"description": "A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"exports": "./dist/index.js",
Expand All @@ -20,11 +20,10 @@
"prettier": "prettier --write \"**/*.{ts,json,yml,yaml,md}\"",
"build": "tsup",
"build:check": "tsc --noEmit",
"update": "pnpm up -L",
"postinstall": "husky",
"update": "pnpm up -L \"!eslint\"",
"prepare": "husky",
"prepublishOnly": "pnpm run lint && pnpm run test",
"prepack": "pnpm run build && pinst --disable",
"postpack": "pinst --enable",
"prepack": "pnpm run build",
"dev:add-docs-to-worktree": "git worktree add --track -b docs docs origin/docs"
},
"repository": {
Expand Down Expand Up @@ -53,35 +52,34 @@
"homepage": "https://distube.js.org/",
"dependencies": {
"tiny-typed-emitter": "^2.1.0",
"undici": "^6.13.0"
"undici": "^6.18.2"
},
"devDependencies": {
"@babel/core": "^7.24.4",
"@babel/plugin-transform-class-properties": "^7.24.1",
"@babel/plugin-transform-object-rest-spread": "^7.24.1",
"@babel/plugin-transform-private-methods": "^7.24.1",
"@babel/preset-env": "^7.24.4",
"@babel/preset-typescript": "^7.24.1",
"@commitlint/cli": "^19.2.2",
"@babel/core": "^7.24.6",
"@babel/plugin-transform-class-properties": "^7.24.6",
"@babel/plugin-transform-object-rest-spread": "^7.24.6",
"@babel/plugin-transform-private-methods": "^7.24.6",
"@babel/preset-env": "^7.24.6",
"@babel/preset-typescript": "^7.24.6",
"@commitlint/cli": "^19.3.0",
"@commitlint/config-conventional": "^19.2.2",
"@discordjs/voice": "^0.16.1",
"@discordjs/voice": "^0.17.0",
"@types/jest": "^29.5.12",
"@types/node": "^20.12.7",
"@types/node": "^20.14.1",
"@types/tough-cookie": "^4.0.5",
"@typescript-eslint/eslint-plugin": "^7.7.0",
"@typescript-eslint/parser": "^7.7.0",
"@typescript-eslint/eslint-plugin": "^7.12.0",
"@typescript-eslint/parser": "^7.12.0",
"babel-jest": "^29.7.0",
"discord.js": "^14.14.1",
"discord.js": "^14.15.3",
"eslint": "^8.57.0",
"eslint-config-distube": "^1.7.0",
"husky": "^9.0.11",
"jest": "^29.7.0",
"nano-staged": "^0.8.0",
"pinst": "^3.0.0",
"prettier": "^3.2.5",
"prettier": "^3.3.0",
"sodium-native": "^4.1.1",
"ts-node": "^10.9.2",
"tsup": "^8.0.2",
"tsup": "^8.1.0",
"typedoc": "^0.25.13",
"typedoc-material-theme": "^1.0.2",
"typescript": "^5.4.5"
Expand Down
Loading

0 comments on commit 535ef4b

Please sign in to comment.