Compare commits
41 Commits
docker
...
3c4dc51855
| Author | SHA1 | Date | |
|---|---|---|---|
| 3c4dc51855 | |||
| 75185a59c3 | |||
| 5b51e3f529 | |||
| 99a1417c43 | |||
| 6546cb8d63 | |||
| b958e79a98 | |||
| 81c65a3644 | |||
| 68a3f4fb58 | |||
| 5c5574c06e | |||
| 9e02e50693 | |||
| 9d7ff5e7e7 | |||
| 3ba230e6e9 | |||
| 253f369a89 | |||
| 7500ea01c8 | |||
| f31bba40fb | |||
| 4d5c301c46 | |||
| 8f8ff6aa81 | |||
| ca9e531541 | |||
| f1991f7716 | |||
| ce635cb32b | |||
| 30b5b23868 | |||
| 74cac2bfbb | |||
| bb7a796cf9 | |||
| a54becb3a0 | |||
| 0d0125bf55 | |||
| 854cf12d64 | |||
| e54c23cc63 | |||
| 5a29fe3d9d | |||
| 42de01e004 | |||
| 537a8c6709 | |||
|
|
0b86b5d891 | ||
| d4de2feaaa | |||
| 95ea55d972 | |||
| 170faf7d01 | |||
| f50c88515e | |||
| 57d10ddf70 | |||
| 6daf1993d1 | |||
| 47de3823f3 | |||
| 74dfdbf667 | |||
| 5c632556b7 | |||
| 05fec6747d |
17
.env.example
Normal file
17
.env.example
Normal file
@@ -0,0 +1,17 @@
|
||||
# Discord Bot Token
|
||||
DISCORD_TOKEN=your_token_here
|
||||
|
||||
# Discord Application Client ID (for command deployment)
|
||||
CLIENT_ID=your_client_id_here
|
||||
|
||||
# Discord Guild ID (optional, for deploying commands to a specific test server)
|
||||
# GUILD_ID=your_guild_id_here
|
||||
|
||||
# Lavalink Configuration
|
||||
# Use 'lavalink' if running via docker-compose, '127.0.0.1' or 'localhost' if running Lavalink directly
|
||||
LAVALINK_HOST=lavalink
|
||||
LAVALINK_PORT=2333
|
||||
LAVALINK_PASSWORD=your_password_here
|
||||
|
||||
# Logging Level (e.g., debug, info, warn, error)
|
||||
LOG_LEVEL=info
|
||||
27
.eslintrc.json
Normal file
27
.eslintrc.json
Normal file
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"root": true,
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"parserOptions": {
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module",
|
||||
"project": "./tsconfig.json" // Point ESLint to your TS config
|
||||
},
|
||||
"plugins": [
|
||||
"@typescript-eslint",
|
||||
"prettier" // Integrates Prettier rules into ESLint
|
||||
],
|
||||
"extends": [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/recommended", // Recommended TS rules
|
||||
"plugin:@typescript-eslint/recommended-requiring-type-checking", // Rules requiring type info
|
||||
"plugin:prettier/recommended" // Enables eslint-plugin-prettier and eslint-config-prettier
|
||||
],
|
||||
"rules": {
|
||||
// Add or override specific rules here if needed
|
||||
"prettier/prettier": "warn", // Show Prettier issues as warnings
|
||||
"@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }], // Warn about unused vars, allow underscores
|
||||
"@typescript-eslint/explicit-module-boundary-types": "off", // Allow inferred return types for now
|
||||
"@typescript-eslint/no-explicit-any": "warn" // Warn about using 'any'
|
||||
},
|
||||
"ignorePatterns": ["node_modules/", "dist/", "data/", "*.db", "*.db-journal", "*.db-wal"]
|
||||
}
|
||||
37
.gitignore
vendored
37
.gitignore
vendored
@@ -1,22 +1,23 @@
|
||||
# ---> Rust
|
||||
# Generated by Cargo
|
||||
# will have compiled files and executables
|
||||
debug/
|
||||
target/
|
||||
# Node modules
|
||||
node_modules/
|
||||
dist/
|
||||
|
||||
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
|
||||
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
|
||||
Cargo.lock
|
||||
# dotenv environment variables
|
||||
.env
|
||||
|
||||
# These are backup files generated by rustfmt
|
||||
**/*.rs.bk
|
||||
# VSCode settings
|
||||
.vscode/
|
||||
|
||||
# MSVC Windows builds of rustc generate these, which store debugging information
|
||||
*.pdb
|
||||
# Mac system files
|
||||
.DS_Store
|
||||
|
||||
# RustRover
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
# Lockfiles
|
||||
pnpm-lock.yaml
|
||||
|
||||
# Logs
|
||||
npm-debug.log*
|
||||
logs/
|
||||
*.log
|
||||
|
||||
# Data directory
|
||||
data/
|
||||
|
||||
21
.prettierignore
Normal file
21
.prettierignore
Normal file
@@ -0,0 +1,21 @@
|
||||
# Ignore artifacts:
|
||||
node_modules
|
||||
dist
|
||||
coverage
|
||||
data
|
||||
*.db
|
||||
*.db-journal
|
||||
*.db-wal
|
||||
|
||||
# Ignore configuration files managed by other tools:
|
||||
package-lock.json
|
||||
pnpm-lock.yaml
|
||||
yarn.lock
|
||||
|
||||
# Ignore logs:
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Ignore environment files:
|
||||
.env*
|
||||
!.env.example
|
||||
9
.prettierrc.json
Normal file
9
.prettierrc.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"semi": true,
|
||||
"trailingComma": "es5",
|
||||
"singleQuote": false,
|
||||
"printWidth": 80,
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"endOfLine": "lf"
|
||||
}
|
||||
45
Dockerfile
Normal file
45
Dockerfile
Normal file
@@ -0,0 +1,45 @@
|
||||
# ---- Build Stage ----
|
||||
FROM node:23-alpine AS builder
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Install pnpm and necessary build tools (if native modules are used)
|
||||
RUN apk add --no-cache python3 make g++ pnpm
|
||||
|
||||
# Copy package manifests
|
||||
COPY package.json pnpm-lock.yaml ./
|
||||
|
||||
# Install ALL dependencies (including devDependencies needed for build)
|
||||
RUN pnpm install --frozen-lockfile
|
||||
|
||||
# Copy the rest of the source code
|
||||
COPY . .
|
||||
|
||||
# Compile TypeScript
|
||||
RUN pnpm run build
|
||||
|
||||
# Prune devDependencies after build (optional but good practice)
|
||||
RUN pnpm prune --prod
|
||||
|
||||
|
||||
# ---- Production Stage ----
|
||||
FROM node:23-alpine
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
ENV NODE_ENV=production
|
||||
|
||||
# Copy necessary files from the builder stage
|
||||
COPY --from=builder /app/node_modules ./node_modules
|
||||
COPY --from=builder /app/dist ./dist
|
||||
COPY --from=builder /app/package.json ./package.json
|
||||
# Copy other runtime necessities (adjust if needed)
|
||||
# COPY .env.example ./
|
||||
# COPY application.yml ./
|
||||
# COPY plugins ./plugins
|
||||
|
||||
# Expose port if needed (though likely not for a Discord bot)
|
||||
# EXPOSE 3000
|
||||
|
||||
# Run the compiled JavaScript application
|
||||
CMD ["node", "dist/index.js"]
|
||||
68
README.md
68
README.md
@@ -1,3 +1,69 @@
|
||||
# discord-music-bot
|
||||
|
||||
Discord bot made in Rust using serenity and lavalink-rs
|
||||
Discord music bot template written in NodeJS using `discord.js` and `erela.js`, with Lavalink support.
|
||||
|
||||
## Features
|
||||
|
||||
- Slash commands: `/ping`, `/join`, `/play`, `/leave`
|
||||
- Lavalink integration for audio playback
|
||||
- Modular command handler structure
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js (>=14)
|
||||
- pnpm or npm
|
||||
- A Discord application with bot token
|
||||
- LavaLink server for audio streaming
|
||||
|
||||
## Setup
|
||||
|
||||
1. Copy `.env.example` to `.env` and fill in your credentials:
|
||||
```env
|
||||
DISCORD_TOKEN=your_discord_bot_token
|
||||
CLIENT_ID=your_discord_application_id
|
||||
LAVALINK_HOST=127.0.0.1
|
||||
LAVALINK_PORT=2333
|
||||
LAVALINK_PASSWORD=your_lavalink_password
|
||||
```
|
||||
2. Install dependencies:
|
||||
```sh
|
||||
pnpm install
|
||||
```
|
||||
3. Run tests:
|
||||
```sh
|
||||
pnpm test
|
||||
```
|
||||
4. Register slash commands:
|
||||
```sh
|
||||
pnpm start # or node deploy-commands.js
|
||||
```
|
||||
5. Start the bot:
|
||||
```sh
|
||||
pnpm start
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
A `Dockerfile` and `docker-compose.yml` are provided for containerized deployment.
|
||||
|
||||
- Build and run with Docker Compose:
|
||||
```sh
|
||||
docker-compose up --build
|
||||
```
|
||||
- Environment variables are loaded from `.env`.
|
||||
- Lavalink service is configured in `docker-compose.yml` alongside the bot.
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/index.js` — Entry point
|
||||
- `src/commands/` — Slash command modules
|
||||
- `src/events/` — Discord event handlers
|
||||
- `src/structures/` — Erela.js (Lavalink) event wiring
|
||||
- `src/utils/logger.js` — Logging setup
|
||||
- `deploy-commands.js` — Slash command registration script
|
||||
- `Dockerfile` — Bot container image
|
||||
- `docker-compose.yml` — Multi-service setup (bot + Lavalink)
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
116
application.yml
Normal file
116
application.yml
Normal file
@@ -0,0 +1,116 @@
|
||||
server: # REST and WS server
|
||||
port: 2333
|
||||
address: 0.0.0.0
|
||||
http2:
|
||||
enabled: false # Whether to enable HTTP/2 support
|
||||
# Root level plugin configuration block
|
||||
plugins:
|
||||
youtube:
|
||||
enabled: true # Whether this source can be used.
|
||||
allowSearch: true # Whether "ytsearch:" and "ytmsearch:" can be used.
|
||||
allowDirectVideoIds: true # Whether just video IDs can match. If false, only complete URLs will be loaded.
|
||||
allowDirectPlaylistIds: true # Whether just playlist IDs can match. If false, only complete URLs will be loaded.
|
||||
# The clients to use for track loading. See below for a list of valid clients.
|
||||
# Clients are queried in the order they are given (so the first client is queried first and so on...)
|
||||
clients:
|
||||
- WEB
|
||||
- WEBEMBEDDED
|
||||
- MUSIC
|
||||
oauth:
|
||||
enabled: true
|
||||
# If you obtain a refresh token after the initial OAuth flow, you can add it here
|
||||
# refreshToken: "paste your refresh token here if applicable"
|
||||
# Leave skipInitialization commented for first-time setup
|
||||
# skipInitialization: true
|
||||
lavalink:
|
||||
plugins:
|
||||
# - dependency: "com.github.example:example-plugin:1.0.0" # required, the coordinates of your plugin
|
||||
# repository: "https://maven.example.com/releases" # optional, defaults to the Lavalink releases repository by default
|
||||
# snapshot: false # optional, defaults to false, used to tell Lavalink to use the snapshot repository instead of the release repository
|
||||
pluginsDir: "/plugins" # Set directory for manually loaded plugins
|
||||
# defaultPluginRepository: "https://maven.lavalink.dev/releases" # optional, defaults to the Lavalink release repository
|
||||
# defaultPluginSnapshotRepository: "https://maven.lavalink.dev/snapshots" # optional, defaults to the Lavalink snapshot repository
|
||||
server:
|
||||
password: "${LAVALINK_PASSWORD}" # Use environment variable
|
||||
sources:
|
||||
# The default Youtube source is now deprecated and won't receive further updates. Please use https://github.com/lavalink-devs/youtube-source#plugin instead.
|
||||
youtube: false
|
||||
bandcamp: false
|
||||
soundcloud: false
|
||||
twitch: false
|
||||
vimeo: false
|
||||
nico: false
|
||||
http: false # warning: keeping HTTP enabled without a proxy configured could expose your server's IP address.
|
||||
local: false
|
||||
filters: # All filters are enabled by default
|
||||
volume: true
|
||||
equalizer: true
|
||||
karaoke: true
|
||||
timescale: true
|
||||
tremolo: true
|
||||
vibrato: true
|
||||
distortion: true
|
||||
rotation: true
|
||||
channelMix: true
|
||||
lowPass: true
|
||||
nonAllocatingFrameBuffer: false # Setting to true reduces the number of allocations made by each player at the expense of frame rebuilding (e.g. non-instantaneous volume changes)
|
||||
bufferDurationMs: 400 # The duration of the NAS buffer. Higher values fare better against longer GC pauses. Duration <= 0 to disable JDA-NAS. Minimum of 40ms, lower values may introduce pauses.
|
||||
frameBufferDurationMs: 5000 # How many milliseconds of audio to keep buffered
|
||||
opusEncodingQuality: 10 # Opus encoder quality. Valid values range from 0 to 10, where 10 is best quality but is the most expensive on the CPU.
|
||||
resamplingQuality: LOW # Quality of resampling operations. Valid values are LOW, MEDIUM and HIGH, where HIGH uses the most CPU.
|
||||
trackStuckThresholdMs: 10000 # The threshold for how long a track can be stuck. A track is stuck if does not return any audio data.
|
||||
useSeekGhosting: true # Seek ghosting is the effect where whilst a seek is in progress, the audio buffer is read from until empty, or until seek is ready.
|
||||
youtubePlaylistLoadLimit: 6 # Number of pages at 100 each
|
||||
playerUpdateInterval: 5 # How frequently to send player updates to clients, in seconds
|
||||
youtubeSearchEnabled: true
|
||||
soundcloudSearchEnabled: true
|
||||
gc-warnings: true
|
||||
#ratelimit:
|
||||
#ipBlocks: ["1.0.0.0/8", "..."] # list of ip blocks
|
||||
#excludedIps: ["...", "..."] # ips which should be explicit excluded from usage by lavalink
|
||||
#strategy: "RotateOnBan" # RotateOnBan | LoadBalance | NanoSwitch | RotatingNanoSwitch
|
||||
#searchTriggersFail: true # Whether a search 429 should trigger marking the ip as failing
|
||||
#retryLimit: -1 # -1 = use default lavaplayer value | 0 = infinity | >0 = retry will happen this numbers times
|
||||
#youtubeConfig: # Required for avoiding all age restrictions by YouTube, some restricted videos still can be played without.
|
||||
#email: "" # Email of Google account
|
||||
#password: "" # Password of Google account
|
||||
#httpConfig: # Useful for blocking bad-actors from ip-grabbing your music node and attacking it, this way only the http proxy will be attacked
|
||||
#proxyHost: "localhost" # Hostname of the proxy, (ip or domain)
|
||||
#proxyPort: 3128 # Proxy port, 3128 is the default for squidProxy
|
||||
#proxyUser: "" # Optional user for basic authentication fields, leave blank if you don't use basic auth
|
||||
#proxyPassword: "" # Password for basic authentication
|
||||
|
||||
metrics:
|
||||
prometheus:
|
||||
enabled: false
|
||||
endpoint: /metrics
|
||||
|
||||
sentry:
|
||||
dsn: ""
|
||||
environment: ""
|
||||
# tags:
|
||||
# some_key: some_value
|
||||
# another_key: another_value
|
||||
|
||||
logging:
|
||||
file:
|
||||
path: ./logs/
|
||||
|
||||
level:
|
||||
root: INFO
|
||||
lavalink: INFO
|
||||
dev.lavalink.youtube: INFO # General YouTube plugin logging
|
||||
dev.lavalink.youtube.http.YoutubeOauth2Handler: INFO # Specific OAuth flow logging
|
||||
|
||||
request:
|
||||
enabled: true
|
||||
includeClientInfo: true
|
||||
includeHeaders: false
|
||||
includeQueryString: true
|
||||
includePayload: true
|
||||
maxPayloadLength: 10000
|
||||
|
||||
logback:
|
||||
rollingpolicy:
|
||||
max-file-size: 1GB
|
||||
max-history: 30
|
||||
103
deploy-commands.ts
Normal file
103
deploy-commands.ts
Normal file
@@ -0,0 +1,103 @@
|
||||
import { REST, Routes, APIApplicationCommand } from 'discord.js';
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import logger from './src/utils/logger'; // Use default import now
|
||||
import dotenv from 'dotenv';
|
||||
|
||||
// --- Setup ---
|
||||
dotenv.config(); // Load .env variables
|
||||
|
||||
// Log presence of required env vars (optional, but helpful for debugging)
|
||||
// logger.info(`CLIENT_ID: ${process.env.CLIENT_ID ? 'Present' : 'MISSING!'}`);
|
||||
// logger.info(`DISCORD_TOKEN: ${process.env.DISCORD_TOKEN ? 'Present' : 'MISSING!'}`);
|
||||
|
||||
// --- Configuration ---
|
||||
const clientId = process.env.CLIENT_ID;
|
||||
const token = process.env.DISCORD_TOKEN;
|
||||
|
||||
if (!clientId || !token) {
|
||||
logger.error('Missing CLIENT_ID or DISCORD_TOKEN in .env file for command deployment!');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const commands: Omit<APIApplicationCommand, 'id' | 'application_id' | 'version'>[] = []; // Type the commands array more accurately
|
||||
// Grab all the command files from the commands directory
|
||||
const commandsPath = path.join(__dirname, 'src', 'commands');
|
||||
// Read .ts files now
|
||||
const commandFiles = fs.readdirSync(commandsPath).filter((file: string) => file.endsWith('.ts')); // Add string type
|
||||
|
||||
// Grab the SlashCommandBuilder#toJSON() output of each command's data for deployment
|
||||
logger.info(`Started loading ${commandFiles.length} application (/) commands for deployment.`);
|
||||
|
||||
const loadCommandsForDeployment = async () => {
|
||||
for (const file of commandFiles) {
|
||||
const filePath = path.join(commandsPath, file);
|
||||
try {
|
||||
// Use dynamic import
|
||||
const commandModule = await import(filePath);
|
||||
// Assuming commands export default or have a 'default' property
|
||||
const command = commandModule.default || commandModule;
|
||||
|
||||
if (command && typeof command === 'object' && 'data' in command && typeof command.data.toJSON === 'function') {
|
||||
// We push the JSON representation which matches the API structure
|
||||
commands.push(command.data.toJSON());
|
||||
logger.info(`Loaded command for deployment: ${command.data.name}`);
|
||||
} else {
|
||||
logger.warn(`[WARNING] The command at ${filePath} is missing a required "data" property with a "toJSON" method.`);
|
||||
}
|
||||
} catch (error: unknown) { // Type error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error loading command at ${filePath} for deployment: ${errorMessage}`, error);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Construct and prepare an instance of the REST module
|
||||
const rest = new REST({ version: '10' }).setToken(token);
|
||||
|
||||
// Define the deployment function
|
||||
const deployCommands = async () => {
|
||||
try {
|
||||
await loadCommandsForDeployment(); // Wait for commands to be loaded
|
||||
|
||||
if (commands.length === 0) {
|
||||
logger.warn('No commands loaded for deployment. Exiting.');
|
||||
return;
|
||||
}
|
||||
|
||||
logger.info(`Started refreshing ${commands.length} application (/) commands.`);
|
||||
|
||||
// The put method is used to fully refresh all commands
|
||||
const guildId = process.env.GUILD_ID;
|
||||
let data: any; // Type appropriately if possible, depends on discord.js version
|
||||
|
||||
if (guildId) {
|
||||
// Deploying to a specific guild (faster for testing)
|
||||
logger.info(`Deploying commands to guild: ${guildId}`);
|
||||
data = await rest.put(
|
||||
Routes.applicationGuildCommands(clientId, guildId),
|
||||
{ body: commands },
|
||||
);
|
||||
logger.info(`Successfully reloaded ${data.length} application (/) commands in guild ${guildId}.`);
|
||||
} else {
|
||||
// Deploying globally (can take up to an hour)
|
||||
logger.info('Deploying commands globally...');
|
||||
data = await rest.put(
|
||||
Routes.applicationCommands(clientId),
|
||||
{ body: commands },
|
||||
);
|
||||
logger.info(`Successfully reloaded ${data.length} global application (/) commands.`);
|
||||
}
|
||||
|
||||
} catch (error: unknown) { // Type error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Failed during command deployment: ${errorMessage}`, error);
|
||||
}
|
||||
};
|
||||
|
||||
// Execute the deployment
|
||||
deployCommands();
|
||||
|
||||
// Note: The old wipe logic is removed as PUT overwrites existing commands.
|
||||
// If you specifically need to wipe commands first for some reason,
|
||||
// you can add separate PUT requests with an empty body before deploying.
|
||||
46
docker-compose.yml
Normal file
46
docker-compose.yml
Normal file
@@ -0,0 +1,46 @@
|
||||
services:
|
||||
lavalink:
|
||||
image: fredboat/lavalink:latest
|
||||
container_name: lavalink
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- bot-network
|
||||
ports:
|
||||
- "2333:2333"
|
||||
environment:
|
||||
- LAVALINK_SERVER_PASSWORD=${LAVALINK_PASSWORD}
|
||||
# Removed LAVALINK_PLUGIN_URLS environment variable
|
||||
volumes:
|
||||
- ./application.yml:/opt/Lavalink/application.yml:ro,Z
|
||||
# Mount local plugins directory into the container with SELinux label
|
||||
- ./plugins:/plugins:ro,Z
|
||||
# Add healthcheck to verify Lavalink is ready
|
||||
healthcheck:
|
||||
# Use CMD-SHELL to allow environment variable expansion for the password
|
||||
test: ["CMD-SHELL", "curl -H \"Authorization: $$LAVALINK_SERVER_PASSWORD\" -f http://localhost:2333/version || exit 1"]
|
||||
interval: 10s # Increased interval slightly
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
start_period: 15s # Give Lavalink time to start up initially
|
||||
# Removed command override, will use default image entrypoint
|
||||
|
||||
bot:
|
||||
build: .
|
||||
container_name: discord-music-bot
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- bot-network
|
||||
env_file:
|
||||
- .env
|
||||
environment:
|
||||
LAVALINK_HOST: lavalink
|
||||
LAVALINK_PORT: 2333
|
||||
LAVALINK_PASSWORD: ${LAVALINK_PASSWORD}
|
||||
# Update depends_on to wait for healthcheck
|
||||
depends_on:
|
||||
lavalink:
|
||||
condition: service_healthy
|
||||
|
||||
networks:
|
||||
bot-network:
|
||||
driver: bridge
|
||||
38
package.json
Normal file
38
package.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"name": "discord-music-bot",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"start": "node dist/index.js",
|
||||
"dev": "ts-node-dev --respawn --transpile-only src/index.ts",
|
||||
"lint": "eslint src/**/*.ts tests/**/*.ts deploy-commands.ts",
|
||||
"format": "prettier --write src/**/*.ts tests/**/*.ts deploy-commands.ts",
|
||||
"test": "jest"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"discord.js": "^14.18.0",
|
||||
"dotenv": "^16.5.0",
|
||||
"shoukaku": "^4.1.1",
|
||||
"winston": "^3.17.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.14",
|
||||
"@types/js-yaml": "^4.0.9",
|
||||
"@types/node": "^22.14.1",
|
||||
"@typescript-eslint/eslint-plugin": "^8.31.0",
|
||||
"@typescript-eslint/parser": "^8.31.0",
|
||||
"eslint": "^9.25.1",
|
||||
"eslint-config-prettier": "^10.1.2",
|
||||
"eslint-plugin-prettier": "^5.2.6",
|
||||
"jest": "^29.7.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
"prettier": "^3.5.3",
|
||||
"ts-node-dev": "^2.0.0",
|
||||
"typescript": "^5.8.3"
|
||||
}
|
||||
}
|
||||
Binary file not shown.
122
src/commands/join.ts
Normal file
122
src/commands/join.ts
Normal file
@@ -0,0 +1,122 @@
|
||||
import {
|
||||
SlashCommandBuilder,
|
||||
PermissionFlagsBits,
|
||||
ChannelType,
|
||||
ChatInputCommandInteraction, // Import the specific interaction type
|
||||
GuildMember, // Import GuildMember type
|
||||
VoiceBasedChannel // Import VoiceBasedChannel type
|
||||
} from 'discord.js';
|
||||
import logger from '../utils/logger'; // Use default import
|
||||
import { BotClient } from '../index'; // Import the BotClient interface
|
||||
import { Player } from 'shoukaku'; // Import the Player type explicitly
|
||||
|
||||
export default { // Use export default for ES Modules
|
||||
data: new SlashCommandBuilder()
|
||||
.setName('join')
|
||||
.setDescription('Joins your current voice channel'),
|
||||
async execute(interaction: ChatInputCommandInteraction, client: BotClient) { // Add types
|
||||
// Ensure command is run in a guild
|
||||
if (!interaction.guildId || !interaction.guild || !interaction.channelId) {
|
||||
// Reply might fail if interaction is already replied/deferred, use editReply if needed
|
||||
return interaction.reply({ content: 'This command can only be used in a server.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
// Ensure interaction.member is a GuildMember
|
||||
if (!(interaction.member instanceof GuildMember)) {
|
||||
return interaction.reply({ content: 'Could not determine your voice channel.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
|
||||
// Use ephemeral deferral
|
||||
await interaction.deferReply({ ephemeral: true });
|
||||
|
||||
const member = interaction.member; // Already checked it's GuildMember
|
||||
const voiceChannel = member?.voice?.channel;
|
||||
|
||||
// 1. Check if user is in a voice channel
|
||||
if (!voiceChannel) {
|
||||
return interaction.editReply('You need to be in a voice channel to use this command!');
|
||||
}
|
||||
|
||||
// Type assertion for voiceChannel after check
|
||||
const currentVoiceChannel = voiceChannel as VoiceBasedChannel;
|
||||
|
||||
// 2. Check bot permissions
|
||||
const permissions = currentVoiceChannel.permissionsFor(client.user!); // Use non-null assertion for client.user
|
||||
if (!permissions?.has(PermissionFlagsBits.Connect)) { // Optional chaining for permissions
|
||||
return interaction.editReply('I need permission to **connect** to your voice channel!');
|
||||
}
|
||||
if (!permissions?.has(PermissionFlagsBits.Speak)) {
|
||||
return interaction.editReply('I need permission to **speak** in your voice channel!');
|
||||
}
|
||||
// Ensure it's a voice channel (not stage, etc.)
|
||||
if (currentVoiceChannel.type !== ChannelType.GuildVoice) {
|
||||
return interaction.editReply('I can only join standard voice channels.');
|
||||
}
|
||||
|
||||
// Get the initialized Shoukaku instance from the client object
|
||||
const shoukaku = client.shoukaku;
|
||||
if (!shoukaku) {
|
||||
logger.error('Shoukaku instance not found on client object!');
|
||||
return interaction.editReply('The music player is not ready yet. Please try again shortly.');
|
||||
}
|
||||
|
||||
// 3. Get or create the player and connect using Shoukaku
|
||||
// Correctly get player from the players map and type it
|
||||
let player: Player | undefined = shoukaku.players.get(interaction.guildId);
|
||||
|
||||
if (!player) {
|
||||
try {
|
||||
// Create player using the Shoukaku manager
|
||||
player = await shoukaku.joinVoiceChannel({
|
||||
guildId: interaction.guildId,
|
||||
channelId: currentVoiceChannel.id,
|
||||
shardId: interaction.guild.shardId, // Get shardId from guild
|
||||
});
|
||||
|
||||
logger.info(`Created player and connected to voice channel ${currentVoiceChannel.name} (${currentVoiceChannel.id}) in guild ${interaction.guild.name} (${interaction.guildId})`);
|
||||
await interaction.editReply(`Joined ${currentVoiceChannel.name}! Ready to play music.`);
|
||||
|
||||
} catch (error: unknown) { // Type error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Failed to create/connect player for guild ${interaction.guildId}: ${errorMessage}`, error);
|
||||
// Attempt to leave voice channel if connection failed partially
|
||||
shoukaku.leaveVoiceChannel(interaction.guildId).catch((e: unknown) => { // Type catch error
|
||||
const leaveErrorMsg = e instanceof Error ? e.message : String(e);
|
||||
logger.error(`Error leaving VC after failed join: ${leaveErrorMsg}`);
|
||||
});
|
||||
return interaction.editReply('An error occurred while trying to join the voice channel.');
|
||||
}
|
||||
} else {
|
||||
// If player exists, get the corresponding connection
|
||||
const connection = shoukaku.connections.get(interaction.guildId);
|
||||
|
||||
// Check if connection exists and if it's in a different channel
|
||||
if (!connection || connection.channelId !== currentVoiceChannel.id) {
|
||||
try {
|
||||
// Rejoining should handle moving the bot
|
||||
// Note: joinVoiceChannel might implicitly destroy the old player/connection if one exists for the guild.
|
||||
// If issues arise, explicitly call leaveVoiceChannel first.
|
||||
player = await shoukaku.joinVoiceChannel({
|
||||
guildId: interaction.guildId,
|
||||
channelId: currentVoiceChannel.id,
|
||||
shardId: interaction.guild.shardId,
|
||||
});
|
||||
|
||||
logger.info(`Moved player to voice channel ${currentVoiceChannel.name} (${currentVoiceChannel.id}) in guild ${interaction.guildId}`);
|
||||
await interaction.editReply(`Moved to ${currentVoiceChannel.name}!`);
|
||||
} catch (error: unknown) { // Type error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Failed to move player for guild ${interaction.guildId}: ${errorMessage}`, error);
|
||||
return interaction.editReply('An error occurred while trying to move to the voice channel.');
|
||||
}
|
||||
} else {
|
||||
// Already in the correct channel
|
||||
await interaction.editReply(`I'm already in ${currentVoiceChannel.name}!`);
|
||||
}
|
||||
// Example of updating a manually managed text channel context (if needed)
|
||||
// if (player.textChannelId !== interaction.channelId) {
|
||||
// player.textChannelId = interaction.channelId;
|
||||
// logger.debug(`Updated player text channel context to ${interaction.channel?.name} (${interaction.channelId}) in guild ${interaction.guildId}`);
|
||||
// }
|
||||
}
|
||||
},
|
||||
};
|
||||
67
src/commands/leave.ts
Normal file
67
src/commands/leave.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
import {
|
||||
SlashCommandBuilder,
|
||||
ChatInputCommandInteraction, // Import the specific interaction type
|
||||
GuildMember // Import GuildMember type
|
||||
} from 'discord.js';
|
||||
import logger from '../utils/logger'; // Use default import
|
||||
import { BotClient } from '../index'; // Import the BotClient interface
|
||||
// No need to import Player explicitly if we just check connection
|
||||
|
||||
export default { // Use export default for ES Modules
|
||||
data: new SlashCommandBuilder()
|
||||
.setName('leave')
|
||||
.setDescription('Leaves the current voice channel'),
|
||||
async execute(interaction: ChatInputCommandInteraction, client: BotClient) { // Add types
|
||||
// Ensure command is run in a guild
|
||||
if (!interaction.guildId || !interaction.guild) {
|
||||
return interaction.reply({ content: 'This command can only be used in a server.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
// Ensure interaction.member is a GuildMember (optional, but good practice)
|
||||
if (!(interaction.member instanceof GuildMember)) {
|
||||
return interaction.reply({ content: 'Could not verify your membership.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
|
||||
// Use ephemeral deferral
|
||||
await interaction.deferReply({ ephemeral: true });
|
||||
|
||||
// Get the Shoukaku instance
|
||||
const shoukaku = client.shoukaku;
|
||||
if (!shoukaku) {
|
||||
logger.error('Shoukaku instance not found on client object!');
|
||||
return interaction.editReply('The music player is not ready yet.');
|
||||
}
|
||||
|
||||
// Check if a connection exists for this guild
|
||||
const connection = shoukaku.connections.get(interaction.guildId);
|
||||
if (!connection || !connection.channelId) {
|
||||
return interaction.editReply('I am not currently in a voice channel!');
|
||||
}
|
||||
|
||||
// Optional: Check if the user is in the same channel as the bot
|
||||
// const memberVoiceChannelId = interaction.member.voice.channelId;
|
||||
// if (memberVoiceChannelId !== connection.channelId) {
|
||||
// return interaction.editReply('You need to be in the same voice channel as me to make me leave!');
|
||||
// }
|
||||
|
||||
try {
|
||||
const channelId = connection.channelId; // Get channel ID from connection
|
||||
const channel = await client.channels.fetch(channelId).catch(() => null); // Fetch channel for name
|
||||
const channelName = channel && channel.isVoiceBased() ? channel.name : `ID: ${channelId}`; // Get channel name if possible
|
||||
|
||||
// Use Shoukaku's leave method - this destroys player and connection
|
||||
await shoukaku.leaveVoiceChannel(interaction.guildId);
|
||||
|
||||
logger.info(`Left voice channel ${channelName} in guild ${interaction.guild.name} (${interaction.guildId}) by user ${interaction.user.tag}`);
|
||||
await interaction.editReply(`Left ${channelName}.`);
|
||||
|
||||
} catch (error: unknown) { // Type error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error leaving voice channel for guild ${interaction.guildId}: ${errorMessage}`, error);
|
||||
// Attempt to reply even if leave failed partially
|
||||
await interaction.editReply('An error occurred while trying to leave the voice channel.').catch((e: unknown) => { // Type catch error
|
||||
const replyErrorMsg = e instanceof Error ? e.message : String(e);
|
||||
logger.error(`Failed to send error reply for leave command: ${replyErrorMsg}`);
|
||||
});
|
||||
}
|
||||
},
|
||||
};
|
||||
16
src/commands/ping.ts
Normal file
16
src/commands/ping.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { SlashCommandBuilder, ChatInputCommandInteraction } from 'discord.js';
|
||||
// No need to import BotClient if not used directly in execute
|
||||
|
||||
export default { // Use export default for ES Modules
|
||||
data: new SlashCommandBuilder()
|
||||
.setName('ping')
|
||||
.setDescription('Replies with Pong!'),
|
||||
async execute(interaction: ChatInputCommandInteraction) { // Add interaction type
|
||||
// Calculate latency (optional but common for ping commands)
|
||||
const sent = await interaction.reply({ content: 'Pinging...', fetchReply: true, ephemeral: true });
|
||||
const latency = sent.createdTimestamp - interaction.createdTimestamp;
|
||||
const wsPing = interaction.client.ws.ping; // WebSocket heartbeat ping
|
||||
|
||||
await interaction.editReply(`Pong! 🏓\nRoundtrip latency: ${latency}ms\nWebSocket Ping: ${wsPing}ms`);
|
||||
},
|
||||
};
|
||||
347
src/commands/play.ts
Normal file
347
src/commands/play.ts
Normal file
@@ -0,0 +1,347 @@
|
||||
import {
|
||||
SlashCommandBuilder,
|
||||
SlashCommandStringOption, // Import for typing options
|
||||
PermissionFlagsBits,
|
||||
ChannelType,
|
||||
EmbedBuilder,
|
||||
ChatInputCommandInteraction,
|
||||
GuildMember,
|
||||
VoiceBasedChannel
|
||||
} from 'discord.js';
|
||||
import logger from '../utils/logger';
|
||||
import { BotClient } from '../index';
|
||||
// Import necessary Shoukaku types - LavalinkResponse might need a local definition if not exported
|
||||
import { Player, Node, Track, SearchResult, Connection } from 'shoukaku';
|
||||
|
||||
// Define the structure of the Lavalink V4 response (if not directly available from shoukaku types)
|
||||
// Based on https://lavalink.dev/api/rest.html#load-tracks
|
||||
type LavalinkLoadType = 'track' | 'playlist' | 'search' | 'empty' | 'error';
|
||||
|
||||
interface LavalinkResponse {
|
||||
loadType: LavalinkLoadType;
|
||||
data: any; // Data structure varies based on loadType
|
||||
}
|
||||
|
||||
interface LavalinkErrorData {
|
||||
message: string;
|
||||
severity: string;
|
||||
cause: string;
|
||||
}
|
||||
|
||||
interface LavalinkPlaylistInfo {
|
||||
name: string;
|
||||
selectedTrack?: number; // Optional index of the selected track within the playlist
|
||||
}
|
||||
|
||||
interface LavalinkPlaylistData {
|
||||
info: LavalinkPlaylistInfo;
|
||||
pluginInfo: any; // Or specific type if known
|
||||
tracks: Track[];
|
||||
}
|
||||
|
||||
// Export: Extend Player type locally to add queue and textChannelId
|
||||
export interface GuildPlayer extends Player {
|
||||
queue: TrackWithRequester[];
|
||||
textChannelId?: string; // Optional: Store text channel ID for messages
|
||||
}
|
||||
|
||||
// Export: Define TrackWithRequester
|
||||
export interface TrackWithRequester extends Track {
|
||||
// Ensure encoded is strictly string if extending base Track which might have it optional
|
||||
encoded: string;
|
||||
requester: {
|
||||
id: string;
|
||||
tag: string;
|
||||
};
|
||||
}
|
||||
|
||||
// Export: Helper function to start playback if possible
|
||||
export async function playNext(player: GuildPlayer, interaction: ChatInputCommandInteraction) {
|
||||
// Check if player is still valid (might have been destroyed)
|
||||
const shoukaku = (interaction.client as BotClient).shoukaku;
|
||||
if (!shoukaku?.players.has(player.guildId)) {
|
||||
logger.warn(`playNext called for destroyed player in guild ${player.guildId}`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (player.track || player.queue.length === 0) {
|
||||
return; // Already playing or queue is empty
|
||||
}
|
||||
const nextTrack = player.queue.shift();
|
||||
if (!nextTrack) return;
|
||||
|
||||
try {
|
||||
// Check if user provided an OAuth token (could be stored in a database or env variable)
|
||||
const oauthToken = process.env.YOUTUBE_OAUTH_TOKEN;
|
||||
const userData = oauthToken ? { "oauth-token": oauthToken } : undefined;
|
||||
// Fix: Correct usage for playTrack based on Player.ts
|
||||
await player.playTrack({ track: { encoded: nextTrack.encoded, userData: userData} });
|
||||
// logger.info(`Started playing: ${nextTrack.info.title} in guild ${player.guildId}`);
|
||||
} catch (playError: unknown) {
|
||||
const errorMsg = playError instanceof Error ? playError.message : String(playError);
|
||||
logger.error(`Error playing track ${nextTrack.info.title} in guild ${player.guildId}: ${errorMsg}`);
|
||||
// Try to send error message to the stored text channel
|
||||
const channel = interaction.guild?.channels.cache.get(player.textChannelId || interaction.channelId);
|
||||
if (channel?.isTextBased()) {
|
||||
// Fix: Check if e is Error before accessing message
|
||||
channel.send(`Error playing track: ${nextTrack.info.title}. Reason: ${errorMsg}`).catch((e: unknown) => {
|
||||
const sendErrorMsg = e instanceof Error ? e.message : String(e);
|
||||
logger.error(`Failed to send play error message: ${sendErrorMsg}`);
|
||||
});
|
||||
}
|
||||
// Try playing the next track if available
|
||||
await playNext(player, interaction);
|
||||
}
|
||||
}
|
||||
|
||||
export default {
|
||||
data: new SlashCommandBuilder()
|
||||
.setName('play')
|
||||
.setDescription('Plays audio from a URL or search query')
|
||||
.addStringOption((option: SlashCommandStringOption) => // Type option
|
||||
option.setName('query')
|
||||
.setDescription('The URL or search term for the song/playlist')
|
||||
.setRequired(true))
|
||||
.addStringOption((option: SlashCommandStringOption) => // Type option
|
||||
option.setName('source')
|
||||
.setDescription('Specify the search source (defaults to YouTube Music)')
|
||||
.setRequired(false)
|
||||
.addChoices(
|
||||
{ name: 'YouTube Music', value: 'youtubemusic' },
|
||||
{ name: 'YouTube', value: 'youtube' },
|
||||
{ name: 'SoundCloud', value: 'soundcloud' }
|
||||
// Add other sources like 'spotify' if supported by Lavalink plugins
|
||||
)),
|
||||
async execute(interaction: ChatInputCommandInteraction, client: BotClient) {
|
||||
// Ensure command is run in a guild
|
||||
if (!interaction.guildId || !interaction.guild || !interaction.channelId) {
|
||||
return interaction.reply({ content: 'This command can only be used in a server.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
if (!(interaction.member instanceof GuildMember)) {
|
||||
return interaction.reply({ content: 'Could not determine your voice channel.', ephemeral: true }).catch(() => {});
|
||||
}
|
||||
|
||||
await interaction.deferReply(); // Defer reply immediately
|
||||
|
||||
const member = interaction.member;
|
||||
const voiceChannel = member?.voice?.channel;
|
||||
const query = interaction.options.getString('query', true); // Required option
|
||||
const source = interaction.options.getString('source'); // Optional
|
||||
|
||||
// 1. Check if user is in a voice channel
|
||||
if (!voiceChannel) {
|
||||
return interaction.editReply('You need to be in a voice channel to play music!');
|
||||
}
|
||||
const currentVoiceChannel = voiceChannel as VoiceBasedChannel;
|
||||
|
||||
// 2. Check bot permissions
|
||||
const permissions = currentVoiceChannel.permissionsFor(client.user!);
|
||||
if (!permissions?.has(PermissionFlagsBits.Connect)) {
|
||||
return interaction.editReply('I need permission to **connect** to your voice channel!');
|
||||
}
|
||||
if (!permissions?.has(PermissionFlagsBits.Speak)) {
|
||||
return interaction.editReply('I need permission to **speak** in your voice channel!');
|
||||
}
|
||||
if (currentVoiceChannel.type !== ChannelType.GuildVoice) {
|
||||
return interaction.editReply('I can only join standard voice channels.');
|
||||
}
|
||||
|
||||
// Get Shoukaku instance
|
||||
const shoukaku = client.shoukaku;
|
||||
if (!shoukaku) {
|
||||
logger.error('Shoukaku instance not found on client object!');
|
||||
return interaction.editReply('The music player is not ready yet. Please try again shortly.');
|
||||
}
|
||||
|
||||
let player: GuildPlayer | undefined; // Declare player variable outside try block
|
||||
|
||||
try {
|
||||
// 3. Get or create player/connection
|
||||
player = shoukaku.players.get(interaction.guildId) as GuildPlayer | undefined;
|
||||
const connection = shoukaku.connections.get(interaction.guildId);
|
||||
|
||||
if (!player || !connection || connection.channelId !== currentVoiceChannel.id) {
|
||||
// If player/connection doesn't exist or bot is in wrong channel, join/move
|
||||
try {
|
||||
player = await shoukaku.joinVoiceChannel({
|
||||
guildId: interaction.guildId,
|
||||
channelId: currentVoiceChannel.id,
|
||||
shardId: interaction.guild.shardId,
|
||||
}) as GuildPlayer; // Cast to extended type
|
||||
logger.info(`Joined/Moved to voice channel ${currentVoiceChannel.name} (${currentVoiceChannel.id}) for play command.`);
|
||||
// Initialize queue if it's a new player
|
||||
if (!player.queue) {
|
||||
player.queue = [];
|
||||
}
|
||||
player.textChannelId = interaction.channelId; // Store text channel context
|
||||
|
||||
} catch (joinError: unknown) {
|
||||
const errorMsg = joinError instanceof Error ? joinError.message : String(joinError);
|
||||
logger.error(`Failed to join/move player for guild ${interaction.guildId}: ${errorMsg}`, joinError);
|
||||
shoukaku.leaveVoiceChannel(interaction.guildId).catch(() => {}); // Attempt cleanup
|
||||
return interaction.editReply('An error occurred while trying to join the voice channel.');
|
||||
}
|
||||
} else {
|
||||
// Ensure queue exists if player was retrieved
|
||||
if (!player.queue) {
|
||||
player.queue = [];
|
||||
}
|
||||
// Update text channel context if needed
|
||||
player.textChannelId = interaction.channelId;
|
||||
}
|
||||
|
||||
// 4. Determine search identifier based on query and source
|
||||
let identifier: string;
|
||||
const isUrl = query.startsWith('http://') || query.startsWith('https://');
|
||||
|
||||
if (isUrl) {
|
||||
identifier = query; // Use URL directly
|
||||
} else {
|
||||
// Prepend search prefix based on source or default
|
||||
switch (source) {
|
||||
case 'youtube':
|
||||
identifier = `ytsearch:${query}`;
|
||||
break;
|
||||
case 'soundcloud':
|
||||
identifier = `scsearch:${query}`;
|
||||
break;
|
||||
case 'youtubemusic':
|
||||
default: // Default to YouTube Music
|
||||
identifier = `ytmsearch:${query}`;
|
||||
break;
|
||||
}
|
||||
}
|
||||
logger.debug(`Constructed identifier: ${identifier}`);
|
||||
|
||||
// 5. Search for tracks using Lavalink REST API via an ideal node
|
||||
const node = shoukaku.getIdealNode();
|
||||
if (!node) {
|
||||
throw new Error('No available Lavalink node.');
|
||||
}
|
||||
|
||||
// Use the correct return type (LavalinkResponse) and check for undefined
|
||||
const searchResult: LavalinkResponse | undefined = await node.rest.resolve(identifier);
|
||||
|
||||
if (!searchResult) {
|
||||
throw new Error('REST resolve returned undefined or null.');
|
||||
}
|
||||
|
||||
// 6. Process search results and add to queue
|
||||
const responseEmbed = new EmbedBuilder().setColor('#0099ff');
|
||||
let tracksToAdd: TrackWithRequester[] = [];
|
||||
|
||||
// Switch using string literals based on Lavalink V4 load types
|
||||
switch (searchResult.loadType) {
|
||||
case 'track': { // Use 'track'
|
||||
const track = searchResult.data as Track;
|
||||
// Ensure track and encoded exist before pushing
|
||||
if (!track?.encoded) throw new Error('Loaded track is missing encoded data.');
|
||||
tracksToAdd.push({
|
||||
...track,
|
||||
encoded: track.encoded, // Explicitly include non-null encoded
|
||||
requester: { id: interaction.user.id, tag: interaction.user.tag }
|
||||
});
|
||||
responseEmbed
|
||||
.setTitle('Track Added to Queue')
|
||||
.setDescription(`[${track.info.title}](${track.info.uri})`)
|
||||
// Ensure player exists before accessing queue
|
||||
.addFields({ name: 'Position in queue', value: `${player.queue.length + 1}`, inline: true });
|
||||
if (track.info.artworkUrl) responseEmbed.setThumbnail(track.info.artworkUrl); // Use artworkUrl
|
||||
logger.info(`Adding track: ${track.info.title} (Guild: ${interaction.guildId})`);
|
||||
break;
|
||||
}
|
||||
case 'search': { // Use 'search'
|
||||
const tracks = searchResult.data as Track[]; // Data is an array of tracks
|
||||
if (!tracks || tracks.length === 0) throw new Error('Search returned no results.');
|
||||
// Fix: Assign track AFTER the check
|
||||
const track = tracks[0];
|
||||
if (!track?.encoded) throw new Error('Searched track is missing encoded data.');
|
||||
tracksToAdd.push({
|
||||
...track,
|
||||
encoded: track.encoded, // Explicitly include non-null encoded
|
||||
requester: { id: interaction.user.id, tag: interaction.user.tag }
|
||||
});
|
||||
responseEmbed
|
||||
.setTitle('Track Added to Queue')
|
||||
.setDescription(`[${track.info.title}](${track.info.uri})`)
|
||||
.addFields({ name: 'Position in queue', value: `${player.queue.length + 1}`, inline: true });
|
||||
if (track.info.artworkUrl) responseEmbed.setThumbnail(track.info.artworkUrl);
|
||||
logger.info(`Adding track from search: ${track.info.title} (Guild: ${interaction.guildId})`);
|
||||
break;
|
||||
}
|
||||
case 'playlist': { // Use 'playlist'
|
||||
const playlistData = searchResult.data as LavalinkPlaylistData; // Cast to correct structure
|
||||
const playlistInfo = playlistData.info;
|
||||
const playlistTracks = playlistData.tracks;
|
||||
// Fix: Filter out tracks without encoded string and assert non-null for map
|
||||
tracksToAdd = playlistTracks
|
||||
.filter(track => !!track.encoded) // Ensure encoded exists
|
||||
.map(track => ({
|
||||
...track,
|
||||
encoded: track.encoded!, // Add non-null assertion
|
||||
requester: { id: interaction.user.id, tag: interaction.user.tag }
|
||||
}));
|
||||
if (tracksToAdd.length === 0) throw new Error('Playlist contained no playable tracks.');
|
||||
// Fix: Use direct optional chaining on array access
|
||||
responseEmbed
|
||||
.setTitle('Playlist Added to Queue')
|
||||
.setDescription(`**[${playlistInfo.name}](${identifier})** (${tracksToAdd.length} tracks)`) // Use filtered length
|
||||
.addFields({ name: 'Starting track', value: `[${tracksToAdd[0]?.info?.title}](${tracksToAdd[0]?.info?.uri})` }); // Use direct optional chaining
|
||||
logger.info(`Adding playlist: ${playlistInfo.name} (${tracksToAdd.length} tracks) (Guild: ${interaction.guildId})`);
|
||||
break;
|
||||
}
|
||||
case 'empty': // Use 'empty'
|
||||
await interaction.editReply(`No results found for "${query}".`);
|
||||
// Optional: Leave if queue is empty?
|
||||
// if (player && !player.track && player.queue.length === 0) {
|
||||
// await shoukaku.leaveVoiceChannel(interaction.guildId);
|
||||
// }
|
||||
return; // Stop execution
|
||||
case 'error': { // Use 'error'
|
||||
const errorData = searchResult.data as LavalinkErrorData; // Cast to error structure
|
||||
// Fix: Add explicit check for errorData
|
||||
if (errorData) {
|
||||
logger.error(`Failed to load track/playlist: ${errorData.message || 'Unknown reason'} (Severity: ${errorData.severity || 'Unknown'}, Identifier: ${identifier})`);
|
||||
await interaction.editReply(`Failed to load track/playlist. Reason: ${errorData.message || 'Unknown error'}`);
|
||||
} else {
|
||||
logger.error(`Failed to load track/playlist: Unknown error (Identifier: ${identifier})`);
|
||||
await interaction.editReply(`Failed to load track/playlist. Unknown error.`);
|
||||
}
|
||||
return; // Stop execution
|
||||
}
|
||||
default:
|
||||
// Use exhaustive check pattern (will error if a case is missed)
|
||||
const _exhaustiveCheck: never = searchResult.loadType;
|
||||
logger.error(`Unknown loadType received: ${searchResult.loadType}`);
|
||||
await interaction.editReply('Received an unknown response type from the music server.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Add tracks to the player's queue (ensure player exists)
|
||||
if (!player) {
|
||||
// This case should ideally not happen if join logic is correct, but added as safeguard
|
||||
throw new Error('Player is not defined after processing search results.');
|
||||
}
|
||||
player.queue.push(...tracksToAdd);
|
||||
|
||||
// Send confirmation embed
|
||||
await interaction.editReply({ embeds: [responseEmbed] });
|
||||
|
||||
// 7. Start playback if not already playing
|
||||
await playNext(player, interaction);
|
||||
|
||||
} catch (error: unknown) { // Catch errors during the process
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error in play command for query "${query}" in guild ${interaction.guildId}: ${errorMsg}`, error);
|
||||
// Use editReply as interaction is deferred
|
||||
await interaction.editReply('An unexpected error occurred while trying to play the music.').catch((e: unknown) => {
|
||||
const replyErrorMsg = e instanceof Error ? e.message : String(e);
|
||||
logger.error(`Failed to send error reply for play command: ${replyErrorMsg}`);
|
||||
});
|
||||
// Optional: Attempt to leave VC on critical error?
|
||||
// if (shoukaku.players.has(interaction.guildId)) {
|
||||
// await shoukaku.leaveVoiceChannel(interaction.guildId).catch(() => {});
|
||||
// }
|
||||
}
|
||||
},
|
||||
};
|
||||
64
src/events/interactionCreate.ts
Normal file
64
src/events/interactionCreate.ts
Normal file
@@ -0,0 +1,64 @@
|
||||
import { Events, Interaction } from 'discord.js'; // Import Interaction type
|
||||
import logger from '../utils/logger'; // Use default import
|
||||
import { BotClient } from '../index'; // Import BotClient type
|
||||
|
||||
export default { // Use export default
|
||||
name: Events.InteractionCreate,
|
||||
async execute(interaction: Interaction, client: BotClient) { // Add types
|
||||
// Handle only slash commands (ChatInputCommand) for now
|
||||
if (!interaction.isChatInputCommand()) return;
|
||||
|
||||
// Store command name after type check
|
||||
const commandName = interaction.commandName;
|
||||
|
||||
// client.commands should be typed as Collection<string, CommandType> on BotClient
|
||||
const command = client.commands.get(commandName);
|
||||
|
||||
if (!command) {
|
||||
logger.error(`No command matching ${commandName} was found.`);
|
||||
try {
|
||||
// Check if interaction is replyable before attempting reply
|
||||
if (interaction.isRepliable()) {
|
||||
await interaction.reply({ content: 'Error: This command was not found!', ephemeral: true });
|
||||
}
|
||||
} catch (replyError: unknown) { // Type caught error
|
||||
const errorMsg = replyError instanceof Error ? replyError.message : String(replyError);
|
||||
// Use stored commandName variable
|
||||
logger.error(`Failed to send 'command not found' reply for command '${commandName}': ${errorMsg}`);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
// Execute the command's logic
|
||||
// Command execute function expects ChatInputCommandInteraction, but we check type above
|
||||
await command.execute(interaction, client);
|
||||
logger.info(`Executed command '${commandName}' for user ${interaction.user.tag}`);
|
||||
} catch (error: unknown) { // Type caught error
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
// Use stored commandName variable
|
||||
logger.error(`Error executing command '${commandName}': ${errorMsg}`, error);
|
||||
|
||||
// Try to reply to the interaction, otherwise edit the deferred reply if applicable
|
||||
const replyOptions = { content: 'There was an error while executing this command!', ephemeral: true };
|
||||
try {
|
||||
// Check if interaction is replyable before attempting reply/followUp
|
||||
if (!interaction.isRepliable()) {
|
||||
// Use stored commandName variable
|
||||
logger.warn(`Interaction for command '${commandName}' is no longer replyable.`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (interaction.replied || interaction.deferred) {
|
||||
await interaction.followUp(replyOptions);
|
||||
} else {
|
||||
await interaction.reply(replyOptions);
|
||||
}
|
||||
} catch (replyError: unknown) { // Type caught error
|
||||
const replyErrorMsg = replyError instanceof Error ? replyError.message : String(replyError);
|
||||
// Use stored commandName variable
|
||||
logger.error(`Failed to send error reply for command '${commandName}': ${replyErrorMsg}`);
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
31
src/events/ready.ts
Normal file
31
src/events/ready.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import { Events, ActivityType, Client } from 'discord.js'; // Import base Client type
|
||||
import logger from '../utils/logger'; // Use default import
|
||||
import { initializeShoukaku } from '../structures/ShoukakuEvents'; // Import the correct setup function
|
||||
import { BotClient } from '../index'; // Import BotClient type
|
||||
|
||||
export default { // Use export default
|
||||
name: Events.ClientReady,
|
||||
once: true, // This event should only run once
|
||||
async execute(client: BotClient) { // Use BotClient type
|
||||
// Ensure client.user is available
|
||||
if (!client.user) {
|
||||
logger.error('Client user is not available on ready event.');
|
||||
return;
|
||||
}
|
||||
logger.info(`Ready! Logged in as ${client.user.tag}`);
|
||||
|
||||
// Initialize the Shoukaku instance and attach listeners
|
||||
try {
|
||||
// Assign the initialized Shoukaku instance to client.shoukaku
|
||||
client.shoukaku = initializeShoukaku(client);
|
||||
logger.info('Shoukaku instance initialized successfully'); // Log message adjusted slightly
|
||||
} catch (error: unknown) { // Type caught error
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Failed to initialize Shoukaku: ${errorMsg}`);
|
||||
// Depending on the severity, you might want to exit or handle this differently
|
||||
}
|
||||
|
||||
// Set activity status
|
||||
client.user.setActivity('Music | /play', { type: ActivityType.Listening });
|
||||
},
|
||||
};
|
||||
60
src/events/voiceStateUpdate.ts
Normal file
60
src/events/voiceStateUpdate.ts
Normal file
@@ -0,0 +1,60 @@
|
||||
import { Events, VoiceState, ChannelType } from 'discord.js'; // Added ChannelType
|
||||
import logger from '../utils/logger';
|
||||
import { BotClient } from '../index'; // Assuming BotClient is exported from index
|
||||
|
||||
export default { // Use export default for ES modules
|
||||
name: Events.VoiceStateUpdate,
|
||||
execute(oldState: VoiceState, newState: VoiceState, client: BotClient) { // Added types
|
||||
// Shoukaku handles voice state updates internally via its connector.
|
||||
// We don't need to manually pass the update like with Erela.js.
|
||||
// The warning about Erela.js manager not being initialized can be ignored/removed.
|
||||
|
||||
// Custom logic for player cleanup based on voice state changes.
|
||||
const shoukaku = client.shoukaku; // Access Shoukaku instance
|
||||
if (!shoukaku) {
|
||||
// Shoukaku might not be initialized yet
|
||||
logger.debug('Voice state update received, but Shoukaku is not ready yet.');
|
||||
return;
|
||||
}
|
||||
|
||||
const player = shoukaku.players.get(newState.guild.id); // Get player from Shoukaku players collection
|
||||
if (!player) return; // No active player for this guild
|
||||
|
||||
// Get the connection associated with the player's guild
|
||||
const connection = shoukaku.connections.get(player.guildId);
|
||||
const currentChannelId = connection?.channelId; // Get channelId from connection
|
||||
|
||||
// Check if the bot was disconnected (newState has no channelId for the bot)
|
||||
// Add null check for client.user
|
||||
if (client.user && newState.id === client.user.id && !newState.channelId && oldState.channelId === currentChannelId) {
|
||||
logger.info(`Bot was disconnected from voice channel ${oldState.channel?.name || oldState.channelId} in guild ${newState.guild.id}. Destroying player.`);
|
||||
player.destroy(); // Use Shoukaku player's destroy method
|
||||
return; // Exit early as the player is destroyed
|
||||
}
|
||||
|
||||
// Check if the bot's channel is now empty (excluding the bot itself)
|
||||
const channel = currentChannelId ? client.channels.cache.get(currentChannelId) : undefined;
|
||||
|
||||
// Ensure the channel exists, is voice-based, and the update is relevant
|
||||
if (channel?.isVoiceBased() && (newState.channelId === currentChannelId || oldState.channelId === currentChannelId)) {
|
||||
// Fetch members again to ensure freshness after the update
|
||||
const members = channel.members; // Safe to access members now
|
||||
// Add null check for client.user
|
||||
if (client.user && members.size === 1 && members.has(client.user.id)) {
|
||||
logger.info(`Voice channel ${channel.name} (${currentChannelId}) in guild ${newState.guild.id} is now empty (only bot left). Destroying player.`); // Safe to access name
|
||||
// Optional: Add a timeout before destroying
|
||||
// setTimeout(() => {
|
||||
// const currentChannel = client.channels.cache.get(player.voiceChannel);
|
||||
// const currentMembers = currentChannel?.members;
|
||||
// if (currentMembers && currentMembers.size === 1 && currentMembers.has(client.user.id)) {
|
||||
// logger.info(`Timeout finished: Destroying player in empty channel ${channel.name}.`);
|
||||
// player.destroy();
|
||||
// } else {
|
||||
// logger.info(`Timeout finished: Channel ${channel.name} is no longer empty. Player not destroyed.`);
|
||||
// }
|
||||
// }, 60000); // e.g., 1 minute timeout
|
||||
player.destroy(); // Destroy immediately for now
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
186
src/index.ts
Normal file
186
src/index.ts
Normal file
@@ -0,0 +1,186 @@
|
||||
import dotenv from 'dotenv';
|
||||
import {
|
||||
Client,
|
||||
GatewayIntentBits,
|
||||
Collection,
|
||||
Events,
|
||||
BaseInteraction, // Use a base type for now, refine later if needed
|
||||
SlashCommandBuilder, // Assuming commands use this
|
||||
} from 'discord.js';
|
||||
import { Shoukaku, Connectors, NodeOption, ShoukakuOptions } from 'shoukaku';
|
||||
import logger from './utils/logger'; // Assuming logger uses export default or similar
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
// import { fileURLToPath } from 'url'; // Needed for __dirname in ES Modules if module is not CommonJS
|
||||
|
||||
// Define Command structure
|
||||
interface Command {
|
||||
data: Omit<SlashCommandBuilder, "addSubcommand" | "addSubcommandGroup">; // Or appropriate type for your command data
|
||||
execute: (interaction: BaseInteraction, client: BotClient) => Promise<void>; // Adjust interaction type if needed
|
||||
}
|
||||
|
||||
// Define Event structure
|
||||
interface BotEvent {
|
||||
name: string; // Should match discord.js event names or custom names
|
||||
once?: boolean;
|
||||
execute: (...args: any[]) => void; // Use specific types later if possible
|
||||
}
|
||||
|
||||
// Extend the discord.js Client class to include custom properties
|
||||
export interface BotClient extends Client { // Add export keyword
|
||||
commands: Collection<string, Command>;
|
||||
shoukaku: Shoukaku;
|
||||
}
|
||||
|
||||
// --- Setup ---
|
||||
dotenv.config();
|
||||
// __dirname is available in CommonJS modules, which is set in tsconfig.json
|
||||
|
||||
// Validate essential environment variables
|
||||
if (!process.env.DISCORD_TOKEN) {
|
||||
logger.error('DISCORD_TOKEN is missing in the .env file!');
|
||||
process.exit(1);
|
||||
}
|
||||
if (!process.env.LAVALINK_HOST || !process.env.LAVALINK_PORT || !process.env.LAVALINK_PASSWORD) {
|
||||
logger.warn('Lavalink connection details (HOST, PORT, PASSWORD) are missing or incomplete in .env. Music functionality will be limited.');
|
||||
// Decide if the bot should exit or continue without music
|
||||
// process.exit(1); // Uncomment to exit if Lavalink is mandatory
|
||||
}
|
||||
|
||||
// Create a new Discord client instance with necessary intents
|
||||
const client = new Client({
|
||||
intents: [
|
||||
GatewayIntentBits.Guilds,
|
||||
GatewayIntentBits.GuildVoiceStates,
|
||||
GatewayIntentBits.GuildMessages, // Add if needed for prefix commands or message content
|
||||
GatewayIntentBits.MessageContent, // Add if needed for message content
|
||||
],
|
||||
}) as BotClient; // Assert the type here
|
||||
|
||||
// Define Shoukaku nodes
|
||||
const Nodes: NodeOption[] = [
|
||||
{
|
||||
name: process.env.LAVALINK_NAME || 'lavalink-node-1', // Use an env var or default name
|
||||
url: `${process.env.LAVALINK_HOST || 'localhost'}:${process.env.LAVALINK_PORT || 2333}`, // Use || 2333 for default port number
|
||||
auth: process.env.LAVALINK_PASSWORD || 'youshallnotpass', // Password from your Lavalink server config
|
||||
secure: process.env.LAVALINK_SECURE === 'true', // Set to true if using HTTPS/WSS
|
||||
},
|
||||
];
|
||||
|
||||
// Shoukaku options
|
||||
const shoukakuOptions: ShoukakuOptions = {
|
||||
moveOnDisconnect: false, // Whether to move players to another node when a node disconnects
|
||||
resume: true, // Whether to resume players session after Lavalink restarts
|
||||
reconnectTries: 3, // Number of attempts to reconnect to Lavalink
|
||||
reconnectInterval: 5000, // Interval between reconnect attempts in milliseconds
|
||||
// Add other options as needed
|
||||
};
|
||||
|
||||
// Initialize Shoukaku
|
||||
client.shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes, shoukakuOptions);
|
||||
|
||||
// Show the actual Lavalink connection details (without exposing the actual password)
|
||||
logger.info(`Lavalink connection configured to: ${process.env.LAVALINK_HOST}:${process.env.LAVALINK_PORT} (Password: ${process.env.LAVALINK_PASSWORD ? '[SET]' : '[NOT SET]'})`);
|
||||
|
||||
// Collections for commands
|
||||
client.commands = new Collection<string, Command>();
|
||||
|
||||
// --- Command Loading ---
|
||||
const commandsPath = path.join(__dirname, 'commands');
|
||||
// Read .ts files now
|
||||
const commandFiles = fs.readdirSync(commandsPath).filter((file: string) => file.endsWith('.ts'));
|
||||
|
||||
const loadCommands = async () => {
|
||||
for (const file of commandFiles) {
|
||||
const filePath = path.join(commandsPath, file);
|
||||
try {
|
||||
// Use dynamic import for ES Modules/CommonJS interop
|
||||
const commandModule = await import(filePath);
|
||||
const command: Command = commandModule.default || commandModule; // Handle default exports
|
||||
|
||||
if (command && typeof command === 'object' && 'data' in command && 'execute' in command) {
|
||||
client.commands.set(command.data.name, command);
|
||||
logger.info(`Loaded command: ${command.data.name}`);
|
||||
} else {
|
||||
logger.warn(`[WARNING] The command at ${filePath} is missing a required "data" or "execute" property or is not structured correctly.`);
|
||||
}
|
||||
} catch (error: unknown) { // Type the error as unknown
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error loading command at ${filePath}: ${errorMessage}`, error);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// --- Event Handling ---
|
||||
const eventsPath = path.join(__dirname, 'events');
|
||||
// Read .ts files now
|
||||
const eventFiles = fs.readdirSync(eventsPath).filter((file: string) => file.endsWith('.ts'));
|
||||
|
||||
const loadEvents = async () => {
|
||||
for (const file of eventFiles) {
|
||||
const filePath = path.join(eventsPath, file);
|
||||
try {
|
||||
const eventModule = await import(filePath);
|
||||
const event: BotEvent = eventModule.default || eventModule; // Handle default exports
|
||||
|
||||
if (event && typeof event === 'object' && 'name' in event && 'execute' in event) {
|
||||
if (event.once) {
|
||||
client.once(event.name, (...args: any[]) => event.execute(...args, client)); // Pass client
|
||||
logger.info(`Loaded event ${event.name} (once)`);
|
||||
} else {
|
||||
client.on(event.name, (...args: any[]) => event.execute(...args, client)); // Pass client
|
||||
logger.info(`Loaded event ${event.name}`);
|
||||
}
|
||||
} else {
|
||||
logger.warn(`[WARNING] The event at ${filePath} is missing a required "name" or "execute" property or is not structured correctly.`);
|
||||
}
|
||||
} catch (error: unknown) {
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error loading event at ${filePath}: ${errorMessage}`, error);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// --- Shoukaku Event Handling ---
|
||||
client.shoukaku.on('ready', (name: string) => logger.info(`Lavalink Node: ${name} is now connected`));
|
||||
client.shoukaku.on('error', (name: string, error: Error) => logger.error(`Lavalink Node: ${name} emitted an error: ${error.message}`));
|
||||
client.shoukaku.on('close', (name: string, code: number, reason: string | undefined) => logger.warn(`Lavalink Node: ${name} closed with code ${code}. Reason: ${reason || 'No reason'}`));
|
||||
// Corrected disconnect event signature based on common usage and error TS148
|
||||
client.shoukaku.on('disconnect', (name: string, count: number) => {
|
||||
logger.warn(`Lavalink Node: ${name} disconnected. ${count} players were disconnected from this node.`);
|
||||
});
|
||||
|
||||
|
||||
// --- Main Execution ---
|
||||
async function main() {
|
||||
await loadCommands();
|
||||
await loadEvents();
|
||||
|
||||
// Log in to Discord with your client's token
|
||||
try {
|
||||
await client.login(process.env.DISCORD_TOKEN);
|
||||
logger.info('Successfully logged in to Discord.');
|
||||
} catch (error: unknown) {
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Failed to log in: ${errorMessage}`);
|
||||
process.exit(1); // Exit if login fails
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
logger.error(`Error during bot initialization: ${errorMessage}`, error);
|
||||
process.exit(1);
|
||||
});
|
||||
|
||||
|
||||
// Basic error handling
|
||||
process.on('unhandledRejection', (reason: unknown, promise: Promise<any>) => {
|
||||
const reasonMessage = reason instanceof Error ? reason.message : String(reason);
|
||||
logger.error('Unhandled promise rejection:', { reason: reasonMessage, promise });
|
||||
});
|
||||
process.on('uncaughtException', (error: Error, origin: NodeJS.UncaughtExceptionOrigin) => {
|
||||
logger.error(`Uncaught exception: ${error.message}`, { error, origin });
|
||||
// Optional: exit process on critical uncaught exceptions
|
||||
// process.exit(1);
|
||||
});
|
||||
67
src/structures/ShoukakuEvents.ts
Normal file
67
src/structures/ShoukakuEvents.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
import { Shoukaku, NodeOption, ShoukakuOptions, Player, Connectors } from 'shoukaku'; // Removed player event types, Added Connectors
|
||||
// import { Connectors } from 'shoukaku-discord.js'; // Use the discord.js connector - Removed this line
|
||||
import logger from '../utils/logger';
|
||||
import { BotClient } from '../index';
|
||||
// Removed imports from play.ts for now as player listeners are removed
|
||||
|
||||
// Define Node options (replace with your actual Lavalink details from .env)
|
||||
const nodes: NodeOption[] = [
|
||||
{
|
||||
name: process.env.LAVALINK_NAME || 'Lavalink-Node-1',
|
||||
url: process.env.LAVALINK_URL || 'lavalink:2333', // Use service name for Docker Compose if applicable
|
||||
auth: process.env.LAVALINK_AUTH || 'youshallnotpass',
|
||||
secure: process.env.LAVALINK_SECURE === 'true' || false,
|
||||
},
|
||||
];
|
||||
|
||||
// Define Shoukaku options
|
||||
const shoukakuOptions: ShoukakuOptions = {
|
||||
moveOnDisconnect: false,
|
||||
resume: false, // Resume doesn't work reliably across restarts/disconnects without session persistence
|
||||
reconnectTries: 3,
|
||||
reconnectInterval: 5, // In seconds
|
||||
restTimeout: 15000, // In milliseconds
|
||||
voiceConnectionTimeout: 15, // In seconds
|
||||
};
|
||||
|
||||
// Function to initialize Shoukaku and attach listeners
|
||||
export function initializeShoukaku(client: BotClient): Shoukaku {
|
||||
if (!client) {
|
||||
throw new Error("initializeShoukaku requires a client instance.");
|
||||
}
|
||||
|
||||
const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), nodes, shoukakuOptions);
|
||||
|
||||
// --- Shoukaku Node Event Listeners ---
|
||||
shoukaku.on('ready', (name, resumed) =>
|
||||
logger.info(`Lavalink Node '${name}' ready. Resumed: ${resumed}`)
|
||||
);
|
||||
|
||||
shoukaku.on('error', (name, error) =>
|
||||
logger.error(`Lavalink Node '${name}' error: ${error.message}`, error)
|
||||
);
|
||||
|
||||
shoukaku.on('close', (name, code, reason) =>
|
||||
logger.warn(`Lavalink Node '${name}' closed. Code: ${code}. Reason: ${reason || 'No reason'}`)
|
||||
);
|
||||
|
||||
// Fix: Correct disconnect listener signature
|
||||
shoukaku.on('disconnect', (name, count) => {
|
||||
// count = count of players disconnected from the node
|
||||
logger.warn(`Lavalink Node '${name}' disconnected. ${count} players disconnected.`);
|
||||
// If players were not moved, you might want to attempt to reconnect them or clean them up.
|
||||
});
|
||||
|
||||
shoukaku.on('debug', (name, info) => {
|
||||
// Only log debug messages if not in production or if explicitly enabled
|
||||
if (process.env.NODE_ENV !== 'production' || process.env.LAVALINK_DEBUG === 'true') {
|
||||
logger.debug(`Lavalink Node '${name}' debug: ${info}`);
|
||||
}
|
||||
});
|
||||
|
||||
// --- Shoukaku Player Event Listeners ---
|
||||
// REMOVED - These need to be attached differently in Shoukaku v4 (e.g., when player is created)
|
||||
|
||||
logger.info("Shoukaku instance created and node event listeners attached.");
|
||||
return shoukaku;
|
||||
}
|
||||
31
src/utils/logger.ts
Normal file
31
src/utils/logger.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import winston, { format, transports } from 'winston'; // Use ES6 import
|
||||
// No longer needed: import { TransformableInfo } from 'logform';
|
||||
|
||||
// Define the type for the log info object after timestamp is added
|
||||
// We can simplify this for now or try to infer from winston later
|
||||
// type TimestampedLogInfo = TransformableInfo & {
|
||||
// timestamp: string;
|
||||
// };
|
||||
|
||||
const logger = winston.createLogger({
|
||||
level: process.env.LOG_LEVEL || 'info', // Use LOG_LEVEL from env or default to 'info'
|
||||
format: format.combine(
|
||||
format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), // This adds the timestamp
|
||||
format.printf((info: any) => { // Use 'any' for now to bypass strict type checking here
|
||||
// Ensure message exists, handle potential non-string messages if necessary
|
||||
// The 'info' object structure depends on the preceding formatters
|
||||
const timestamp = info.timestamp || new Date().toISOString(); // Fallback if timestamp isn't added
|
||||
const level = (info.level || 'info').toUpperCase();
|
||||
const message = typeof info.message === 'string' ? info.message : JSON.stringify(info.message);
|
||||
return `${timestamp} ${level}: ${message}`;
|
||||
})
|
||||
),
|
||||
transports: [
|
||||
new transports.Console(),
|
||||
// Optionally add file transport
|
||||
// new transports.File({ filename: 'combined.log' }),
|
||||
// new transports.File({ filename: 'error.log', level: 'error' }),
|
||||
],
|
||||
});
|
||||
|
||||
export default logger; // Use ES6 export default
|
||||
55
tests/deploy-commands.test.ts
Normal file
55
tests/deploy-commands.test.ts
Normal file
@@ -0,0 +1,55 @@
|
||||
jest.mock('discord.js', () => {
|
||||
const original = jest.requireActual('discord.js');
|
||||
const mockRest = {
|
||||
put: jest.fn().mockResolvedValue([{ length: 1 }]),
|
||||
setToken: jest.fn().mockReturnThis(),
|
||||
};
|
||||
return {
|
||||
...original,
|
||||
REST: jest.fn(() => mockRest),
|
||||
Routes: {
|
||||
applicationCommands: jest.fn().mockReturnValue('/fake-route'),
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
jest.mock('fs', () => ({
|
||||
readdirSync: jest.fn(() => ['ping.js']),
|
||||
}));
|
||||
jest.mock('node:path', () => {
|
||||
const actual = jest.requireActual('node:path');
|
||||
return {
|
||||
...actual,
|
||||
join: (...args: string[]) => args.join('/'),
|
||||
resolve: (...args: string[]) => args.join('/'),
|
||||
};
|
||||
});
|
||||
|
||||
describe('deploy-commands.js', () => {
|
||||
let origEnv: typeof process.env;
|
||||
beforeAll(() => {
|
||||
origEnv = { ...process.env };
|
||||
process.env.CLIENT_ID = '12345';
|
||||
process.env.DISCORD_TOKEN = 'token';
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
process.env = origEnv;
|
||||
jest.resetModules();
|
||||
});
|
||||
|
||||
test('registers commands via REST API', async () => {
|
||||
const mockLogger = { info: jest.fn(), warn: jest.fn(), error: jest.fn() };
|
||||
jest.mock('../src/utils/logger', () => mockLogger);
|
||||
|
||||
// Run the script
|
||||
await require('../deploy-commands.js');
|
||||
|
||||
const { REST } = require('discord.js');
|
||||
expect(REST).toHaveBeenCalled();
|
||||
const restInstance = REST.mock.results[0].value;
|
||||
expect(restInstance.setToken).toHaveBeenCalledWith('token');
|
||||
expect(restInstance.put).toHaveBeenCalledWith('/fake-route', { body: expect.any(Array) });
|
||||
expect(mockLogger.info).toHaveBeenCalledWith(expect.stringContaining('Started refreshing'));
|
||||
});
|
||||
});
|
||||
10
tests/start-script.test.ts
Normal file
10
tests/start-script.test.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
const { spawnSync } = require('child_process');
|
||||
|
||||
describe('NPM Start Script', () => {
|
||||
test('npm start exits without error when DISCORD_TOKEN is provided', () => {
|
||||
const env = { ...process.env, DISCORD_TOKEN: 'dummy-token', CLIENT_ID: '123', LAVALINK_HOST: 'localhost', LAVALINK_PORT: '2333', LAVALINK_PASSWORD: 'pass' };
|
||||
const result = spawnSync('pnpm', ['start'], { env, encoding: 'utf-8' });
|
||||
// The script starts the bot; if it reaches login attempt, exit code is 0
|
||||
expect(result.status).toBe(0);
|
||||
});
|
||||
});
|
||||
13
tests/startup.test.ts
Normal file
13
tests/startup.test.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
const { spawnSync } = require('child_process');
|
||||
|
||||
describe('Bot Startup', () => {
|
||||
test('exits with code 1 if DISCORD_TOKEN is missing', () => {
|
||||
// Clear DISCORD_TOKEN
|
||||
const env = { ...process.env };
|
||||
delete env.DISCORD_TOKEN;
|
||||
|
||||
const result = spawnSync('node', ['src/index.js'], { env, encoding: 'utf-8' });
|
||||
expect(result.status).toBe(1);
|
||||
expect(result.stderr || result.stdout).toMatch(/DISCORD_TOKEN is missing/);
|
||||
});
|
||||
});
|
||||
37
tsconfig.json
Normal file
37
tsconfig.json
Normal file
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
/* Base Options: */
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"target": "ES2022",
|
||||
"allowJs": true,
|
||||
"resolveJsonModule": true,
|
||||
"moduleDetection": "force",
|
||||
"isolatedModules": true,
|
||||
/* Strictness */
|
||||
"strict": true,
|
||||
"noUncheckedIndexedAccess": true,
|
||||
"checkJs": true,
|
||||
/* If NOT transpiling with TypeScript: */
|
||||
"module": "NodeNext",
|
||||
"noEmit": true,
|
||||
/* If your code runs in the DOM: */
|
||||
// "lib": ["es2022", "dom", "dom.iterable"],
|
||||
/* If your code doesn't run in the DOM: */
|
||||
"lib": ["ES2022"],
|
||||
|
||||
/* If transpiling with TypeScript: */
|
||||
"module": "CommonJS", // Use CommonJS for Node.js compatibility
|
||||
"outDir": "dist", // Output compiled JS to dist/
|
||||
"sourceMap": true, // Generate source maps
|
||||
|
||||
/* Project Structure */
|
||||
// "rootDir": "src", // Remove rootDir as include covers files outside src
|
||||
"baseUrl": ".", // Allows for path aliases if needed
|
||||
"paths": {
|
||||
"@/*": ["src/*"] // Example path alias - keep if used, adjust if needed
|
||||
}
|
||||
},
|
||||
"include": ["src/**/*.ts", "deploy-commands.ts", "tests/**/*.ts"], // Include source, deploy script, and tests
|
||||
"exclude": ["node_modules", "dist"] // Exclude build output and dependencies
|
||||
}
|
||||
50
update-plugin.sh
Executable file
50
update-plugin.sh
Executable file
@@ -0,0 +1,50 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Exit immediately if a command exits with a non-zero status.
|
||||
set -e
|
||||
|
||||
# Define variables
|
||||
PLUGIN_DIR="./plugins"
|
||||
REPO_URL="https://maven.lavalink.dev/snapshots/dev/lavalink/youtube/youtube-plugin"
|
||||
METADATA_URL="${REPO_URL}/maven-metadata.xml"
|
||||
ARTIFACT_ID="youtube-plugin"
|
||||
|
||||
echo "Fetching latest snapshot version..."
|
||||
|
||||
# Fetch metadata and extract the latest snapshot version using grep and sed
|
||||
# Use curl with -sS for silent operation but show errors
|
||||
# Use grep to find the <latest> tag, then sed to extract the content
|
||||
LATEST_VERSION=$(curl -sS "$METADATA_URL" | grep '<latest>' | sed -e 's/.*<latest>\(.*\)<\/latest>.*/\1/')
|
||||
|
||||
if [ -z "$LATEST_VERSION" ]; then
|
||||
echo "Error: Could not determine the latest snapshot version."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Latest snapshot version: $LATEST_VERSION"
|
||||
|
||||
# Construct the JAR filename and download URL
|
||||
JAR_FILENAME="${ARTIFACT_ID}-${LATEST_VERSION}.jar"
|
||||
DOWNLOAD_URL="${REPO_URL}/${LATEST_VERSION}/${JAR_FILENAME}"
|
||||
|
||||
# Create the plugins directory if it doesn't exist
|
||||
mkdir -p "$PLUGIN_DIR"
|
||||
|
||||
# Remove any existing youtube-plugin JARs to avoid conflicts
|
||||
echo "Removing old plugin versions from $PLUGIN_DIR..."
|
||||
rm -f "$PLUGIN_DIR"/youtube-plugin-*.jar
|
||||
|
||||
# Download the latest snapshot JAR
|
||||
echo "Downloading $JAR_FILENAME from $DOWNLOAD_URL..."
|
||||
curl -L -o "$PLUGIN_DIR/$JAR_FILENAME" "$DOWNLOAD_URL"
|
||||
|
||||
# Verify download
|
||||
if [ ! -f "$PLUGIN_DIR/$JAR_FILENAME" ]; then
|
||||
echo "Error: Failed to download the plugin JAR."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Successfully downloaded $JAR_FILENAME to $PLUGIN_DIR"
|
||||
echo "Make sure to restart your Lavalink container for the changes to take effect."
|
||||
|
||||
exit 0
|
||||
Reference in New Issue
Block a user