Update README and add "Now playing" Command (museofficial#589)

Co-authored-by: Max Isom <[email protected]>
Co-authored-by: Max Isom <[email protected]>

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Added a `/now-playing` command to show the current track without the full queue embed
 
 ## [1.6.2] - 2022-03-17
 ### Fixed

README.md

@@ -77,7 +77,9 @@ services:
 
 ### Node.js
 
-**Prerequisites**: Node.js, ffmpeg
+**Prerequisites**:
+* Node.js (16.x is recommended because it's the current LTS version)
+* ffmpeg
 
 1. `git clone https://github.com/codetheweb/muse.git && cd muse`
 2. Copy `.env.example` to `.env` and populate with values

src/commands/now-playing.ts

@@ -0,0 +1,32 @@
+import {CommandInteraction} from 'discord.js';
+import {TYPES} from '../types.js';
+import {inject, injectable} from 'inversify';
+import PlayerManager from '../managers/player.js';
+import Command from '.';
+import {SlashCommandBuilder} from '@discordjs/builders';
+import {buildPlayingMessageEmbed} from '../utils/build-embed.js';
+
+@injectable()
+export default class implements Command {
+  public readonly slashCommand = new SlashCommandBuilder()
+    .setName('now-playing')
+    .setDescription('shows the currently played song');
+
+  private readonly playerManager: PlayerManager;
+
+  constructor(@inject(TYPES.Managers.Player) playerManager: PlayerManager) {
+    this.playerManager = playerManager;
+  }
+
+  public async execute(interaction: CommandInteraction): Promise<void> {
+    const player = this.playerManager.get(interaction.guild!.id);
+
+    if (!player.getCurrent()) {
+      throw new Error('nothing is currently playing');
+    }
+
+    await interaction.reply({
+      embeds: [buildPlayingMessageEmbed(player)],
+    });
+  }
+}

src/inversify.config.ts

@@ -21,6 +21,7 @@ import Config from './commands/config.js';
 import Disconnect from './commands/disconnect.js';
 import Favorites from './commands/favorites.js';
 import ForwardSeek from './commands/fseek.js';
+import NowPlaying from './commands/now-playing.js';
 import Pause from './commands/pause.js';
 import Play from './commands/play.js';
 import QueueCommand from './commands/queue.js';
@@ -65,6 +66,7 @@ container.bind<SpotifyAPI>(TYPES.Services.SpotifyAPI).to(SpotifyAPI).inSingleton
   Disconnect,
   Favorites,
   ForwardSeek,
+  NowPlaying,
   Pause,
   Play,
   QueueCommand,

src/utils/build-embed.ts

@@ -61,8 +61,8 @@ export const buildPlayingMessageEmbed = (player: Player): MessageEmbed => {
   const message = new MessageEmbed();
 
   message
-    .setColor('DARK_GREEN')
-    .setTitle('Now Playing')
+    .setColor(player.status === STATUS.PLAYING ? 'DARK_GREEN' : 'DARK_RED')
+    .setTitle(player.status === STATUS.PLAYING ? 'Now Playing' : 'Paused')
     .setDescription(`
       **${getSongTitle(currentlyPlaying)}**
       Requested by: <@${requestedBy}>\n