feat: initial commit 🥳

development.Dockerfile → .devcontainer/Dockerfile

@@ -1,9 +1,12 @@
-FROM node:19-alpine
+FROM node:19
 
 # Create app/working/bot directory
 RUN mkdir -p /app
 WORKDIR /app
 
+# Before installing ytdl mod, install ffmpeg
+RUN apt-get update && apt-get install 'ffmpeg' -y
+
 # Install app development dependencies
 # A wildcard is used to ensure both package.json AND package-lock.json are copied
 # where available (npm@5+)

.env.example

@@ -1,8 +1,13 @@
 # ------------------------- Required variables ------------------------- #
 NODE_ENV=production
 DISCORD_BOT_TOKEN=
-CLIENT_ID=
-TEST_SERVER_GUILD_ID=
+DISCORD_CLIENT_ID=
+SPOTIFY_CLIENT_ID=
+SPOTIFY_CLIENT_SECRET=
+
+# -------------------------
+  # Everything else is optional - continue if you know what you're doing
+# -------------------------
 
 # ------------------------- Debug variables ------------------------- #
 DEBUG_ENABLED=true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,8 +1,8 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: '[Feature] - '
+labels: 'enhancement'
 assignees: ''
 
 ---

.github/workflows/docker-image.yml

@@ -13,4 +13,4 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Build the Docker image
-      run: docker build . --file Dockerfile --tag discord-bot-template:$(date +%s)
+      run: docker build . --file Dockerfile --tag mirasaki-music-bot:$(date +%s)

.github/workflows/publish.yml

@@ -33,7 +33,7 @@ jobs:
         id: meta
         uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
         with:
-          images: mirasaki/discord-bot-template
+          images: mirasaki/mirasaki-music-bot
 
       - name: Build and push Docker image
         uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc

.github/workflows/release.yml

@@ -19,14 +19,4 @@ jobs:
       - run: npm ci
       - run: npx semantic-release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  notify-finish:
-    needs: release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Discord Webhook - Notify Finish Release
-        uses: tsickert/discord-webhook@v5.3.0
-        with:
-          webhook-url: ${{ secrets.GH_RELEASE_WEBHOOK_URL }}
-          content: "<@&975346074560634940>, a new version was just **released** - go check it out: [here](<${{ github.server_url }}/${{ github.repository }}/releases/latest>)"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -120,3 +120,9 @@ TODO.md
 
 # In-development, Intellisense for events/listeners
 typings.d.ts
+
+# DB and db save
+*.db
+*.db~
+
+TODO

Dockerfile

@@ -1,9 +1,12 @@
-FROM node:19-alpine
+FROM node:19
 
 # Create app/working/bot directory
 RUN mkdir -p /app
 WORKDIR /app
 
+# Before installing ytdl mod, install ffmpeg
+RUN apt-get update && apt-get install 'ffmpeg' -y
+
 # Install app production dependencies
 # A wildcard is used to ensure both package.json AND package-lock.json are copied
 # where available (npm@5+)

config.example.js

@@ -1,42 +1,100 @@
+/**
+ * @type {@type {module:Client~ClientConfiguration}}
+ */
+
 const { PermissionsBitField } = require('discord.js');
 
 const config = {
-  // Array of Intents your bot needs
-  // https://discord.com/developers/docs/topics/gateway#gateway-intents
-  intents: [ 'Guilds' ],
+  // Note: all the default# properties all configurable by commands
+  // This is here so that you can configure everything in one go
+  // without having to figure out different commands,
+  // if you're not comfortable editing this, use the commands
+
+  // Note: default# properties only take affect the first time
+  // playback is initialized in your server/guild
+
+  // Between 0 and 100
+  // 100 is obnoxiously loud and will f*** your ears
+  defaultVolume: 5,
+
+  // The default repeat mode
+  // 0 - Off | Don't repeat
+  // 1 - Track | Repeat current track, always - until skipped
+  // 2 - Queue | Repeat the entire queue, finished songs get added back at the end of the current queue
+  // 3 - Autoplay | Autoplay recommended music when queue is empty
+  //
+  // 3 = 24/7 autoplay/continuous radio if uninterrupted - only use if you have
+  // bandwidth for days
+  defaultRepeatMode: 0,
+
+  // Amount of seconds to stay in the voice channel
+  // when playback is finished
+  // Default: 2 minutes
+  defaultLeaveOnEndCooldown: 120,
+
+  // When true, will create a thread when the voice session is first initialized
+  // and continue to send music/queue events in that thread instead of flooding
+  // the channel
+  defaultUseThreadSessions: true,
+
+  // When true, and defaultUseThreadSessions is true, will only allow commands involving
+  // the current session to be used in the created session Thread channel
+  defaultThreadSessionStrictCommandChannel: true,
+
+  // Plugins/Music source extractors
+  plugins: {
+    youtube: true,
+    fileAttachments: true,
+
+    appleMusic: true,
+    vimeo: true,
+    reverbNation: true,
+    // To disable Spotify:
+    // spotify: false,
+    spotify: {
+      clientId: process.env.SPOTIFY_CLIENT_ID,
+      clientSecret: process.env.SPOTIFY_CLIENT_SECRET
+    },
+
+    // Problematic, slows queries down by ~3 seconds
+    // if enabled, and you can no longer query with
+    // /play, use /search instead, grab the desired link
+    // and /play that instead
+    soundCloud: false
+  },
 
   // Bot activity
   presence: {
     // One of online, idle, invisible, dnd
     status: 'online',
     activities: [
       {
-        name: '/help',
+        name: '/play',
         // One of Playing, Streaming, Listening, Watching
         type: 'Listening'
       }
     ]
   },
 
-  // Additional permissions that are considered required when generating
-  // the bot invite link with /invite
-  permissionsBase: [
-    PermissionsBitField.Flags.ViewChannel,
-    PermissionsBitField.Flags.SendMessages,
-    PermissionsBitField.Flags.SendMessagesInThreads
-  ],
-
   // Permission config
   permissions: {
     // Bot Owner, highest permission level (5)
     ownerId: '290182686365188096',
 
     // Bot developers, second to highest permission level (4)
-    developers: [ '625286565375246366' ]
+    developers: [ '' ]
   },
 
   // The Discord server invite to your Support server
-  supportServerInviteLink: 'https://discord.mirasaki.dev'
+  supportServerInviteLink: 'https://discord.gg/mirasaki',
+
+  // Additional permissions that are considered required when generating
+  // the bot invite link with /invite
+  permissionsBase: [
+    PermissionsBitField.Flags.ViewChannel,
+    PermissionsBitField.Flags.SendMessages,
+    PermissionsBitField.Flags.SendMessagesInThreads
+  ]
 };
 
 module.exports = config;

docker-compose.yml

@@ -10,5 +10,9 @@ services:
       - ./:/app:ro
       # Anonymous volume
       - /app/node_modules
-    env_file:
-      - ./.env
+    environment:
+      - NODE_ENV=production
+      - DISCORD_BOT_TOKEN=
+      - DISCORD_CLIENT_ID=
+      - SPOTIFY_CLIENT_ID=
+      - SPOTIFY_CLIENT_SECRET=