mirror of
https://github.com/jarulsamy/Plex-Bot.git
synced 2024-08-19 15:01:55 +02:00
Compare commits
No commits in common. "master" and "v1.0.3" have entirely different histories.
@ -1,6 +1,8 @@
|
||||
"""
|
||||
Plex music bot for discord.
|
||||
|
||||
Do not import this module, it is intended to be
|
||||
used exclusively within a docker environment.
|
||||
"""
|
||||
import logging
|
||||
import sys
|
||||
@ -17,7 +19,7 @@ plex_log = logging.getLogger("Plex")
|
||||
bot_log = logging.getLogger("Bot")
|
||||
|
||||
|
||||
def load_config(basedir: str,filename: str) -> Dict[str, str]:
|
||||
def load_config(filename: str) -> Dict[str, str]:
|
||||
"""Loads config from yaml file
|
||||
|
||||
Grabs key/value config pairs from a file.
|
||||
@ -33,12 +35,12 @@ def load_config(basedir: str,filename: str) -> Dict[str, str]:
|
||||
"""
|
||||
# All config files should be in /config
|
||||
# for docker deployment.
|
||||
filename = Path(basedir, filename)
|
||||
filename = Path("/config", filename)
|
||||
try:
|
||||
with open(filename, "r") as config_file:
|
||||
config = yaml.safe_load(config_file)
|
||||
except FileNotFoundError:
|
||||
root_log.fatal("Configuration file not found at '"+str(filename)+"'.")
|
||||
root_log.fatal("Configuration file not found.")
|
||||
sys.exit(-1)
|
||||
|
||||
# Convert str level type to logging constant
|
||||
@ -54,7 +56,7 @@ def load_config(basedir: str,filename: str) -> Dict[str, str]:
|
||||
config["plex"]["log_level"] = levels[config["plex"]["log_level"].upper()]
|
||||
config["discord"]["log_level"] = levels[config["discord"]["log_level"].upper()]
|
||||
|
||||
if config["lyrics"] and config["lyrics"]["token"].lower() == "none":
|
||||
config["lyrics"] = None
|
||||
if config["lyrics"]["token"].lower() == "none":
|
||||
config["lyrics"]["token"] = None
|
||||
|
||||
return config
|
||||
|
||||
@ -11,11 +11,7 @@ from .bot import General
|
||||
from .bot import Plex
|
||||
|
||||
# Load config from file
|
||||
configdir = "config"
|
||||
from os import geteuid
|
||||
if geteuid() == 0:
|
||||
configdir = "/config"
|
||||
config = load_config(configdir,"config.yaml")
|
||||
config = load_config("config.yaml")
|
||||
|
||||
BOT_PREFIX = config["discord"]["prefix"]
|
||||
TOKEN = config["discord"]["token"]
|
||||
@ -24,11 +20,8 @@ BASE_URL = config["plex"]["base_url"]
|
||||
PLEX_TOKEN = config["plex"]["token"]
|
||||
LIBRARY_NAME = config["plex"]["library_name"]
|
||||
|
||||
if config["lyrics"]:
|
||||
LYRICS_TOKEN = config["lyrics"]["token"]
|
||||
else:
|
||||
LYRICS_TOKEN = None
|
||||
|
||||
LYRICS_TOKEN = config["lyrics"]["token"]
|
||||
|
||||
# Set appropiate log level
|
||||
root_log = logging.getLogger()
|
||||
plex_log = logging.getLogger("Plex")
|
||||
|
||||
461
PlexBot/bot.py
461
PlexBot/bot.py
@ -3,15 +3,14 @@ import asyncio
|
||||
import io
|
||||
import logging
|
||||
from urllib.request import urlopen
|
||||
import requests
|
||||
|
||||
import discord
|
||||
import lyricsgenius
|
||||
from async_timeout import timeout
|
||||
from discord import FFmpegPCMAudio
|
||||
from discord.ext import commands
|
||||
from discord.ext.commands import command
|
||||
from plexapi.exceptions import Unauthorized
|
||||
from plexapi.exceptions import NotFound
|
||||
from plexapi.server import PlexServer
|
||||
|
||||
from .exceptions import MediaNotFoundError
|
||||
@ -30,19 +29,11 @@ General:
|
||||
Plex:
|
||||
play <SONG_NAME> - Play a song from the plex server.
|
||||
album <ALBUM_NAME> - Queue an entire album to play.
|
||||
playlist <PLAYLIST_NAME> - Queue an entire playlist to play.
|
||||
show_playlists <ARG> <ARG> - Query for playlists with a name matching any of the arguments.
|
||||
lyrics - Print the lyrics of the song (Requires Genius API)
|
||||
np - Print the current playing song.
|
||||
q - Print the current queue (This can take very long!)
|
||||
stop - Halt playback and leave vc.
|
||||
loop - Loop the current song.
|
||||
loopq - Loop the current queue.
|
||||
unloop - Disable looping the current track.
|
||||
unloopq - Disable looping the current queue.
|
||||
pause - Pause playback.
|
||||
resume - Resume playback.
|
||||
skip - Skip the current song. Give a number as argument to skip more than 1.
|
||||
clear - Clear play queue.
|
||||
|
||||
[] - Optional args.
|
||||
@ -50,15 +41,13 @@ Plex:
|
||||
|
||||
|
||||
class General(commands.Cog):
|
||||
"""
|
||||
General commands
|
||||
"""General commands
|
||||
|
||||
Manage general bot behavior
|
||||
"""
|
||||
|
||||
def __init__(self, bot):
|
||||
"""
|
||||
Initialize commands
|
||||
"""Initialize commands
|
||||
|
||||
Args:
|
||||
bot: discord.ext.command.Bot, bind for cogs
|
||||
@ -73,8 +62,7 @@ class General(commands.Cog):
|
||||
|
||||
@command()
|
||||
async def kill(self, ctx, *args):
|
||||
"""
|
||||
Kill the bot
|
||||
"""Kill the bot
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -94,8 +82,7 @@ class General(commands.Cog):
|
||||
|
||||
@command(name="help")
|
||||
async def help(self, ctx):
|
||||
"""
|
||||
Prints command help
|
||||
"""Prints command help
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -111,8 +98,7 @@ class General(commands.Cog):
|
||||
|
||||
@command()
|
||||
async def cleanup(self, ctx, limit=250):
|
||||
"""
|
||||
Delete old messages from bot
|
||||
"""Delete old messages from bot
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -162,8 +148,7 @@ class Plex(commands.Cog):
|
||||
# within the bot.
|
||||
|
||||
def __init__(self, bot, **kwargs):
|
||||
"""
|
||||
Initializes Plex resources
|
||||
"""Initializes Plex resources
|
||||
|
||||
Connects to Plex library and sets up
|
||||
all asyncronous communications.
|
||||
@ -188,7 +173,6 @@ class Plex(commands.Cog):
|
||||
self.bot_prefix = bot.command_prefix
|
||||
|
||||
if kwargs["lyrics_token"]:
|
||||
import lyricsgenius
|
||||
self.genius = lyricsgenius.Genius(kwargs["lyrics_token"])
|
||||
else:
|
||||
plex_log.warning("No lyrics token specified, lyrics disabled")
|
||||
@ -207,10 +191,7 @@ class Plex(commands.Cog):
|
||||
# Initialize necessary vars
|
||||
self.voice_channel = None
|
||||
self.current_track = None
|
||||
self.is_looping = False
|
||||
self.loop_queue = None
|
||||
self.np_message_id = None
|
||||
self.show_queue_message_ids = []
|
||||
self.ctx = None
|
||||
|
||||
# Initialize events
|
||||
@ -221,8 +202,7 @@ class Plex(commands.Cog):
|
||||
self.bot.loop.create_task(self._audio_player_task())
|
||||
|
||||
def _search_tracks(self, title: str):
|
||||
"""
|
||||
Search the Plex music db for track
|
||||
"""Search the Plex music db for track
|
||||
|
||||
Args:
|
||||
title: str title of song to search for
|
||||
@ -240,8 +220,7 @@ class Plex(commands.Cog):
|
||||
raise MediaNotFoundError("Track cannot be found")
|
||||
|
||||
def _search_albums(self, title: str):
|
||||
"""
|
||||
Search the Plex music db for album
|
||||
"""Search the Plex music db for album
|
||||
|
||||
Args:
|
||||
title: str title of album to search for
|
||||
@ -258,36 +237,8 @@ class Plex(commands.Cog):
|
||||
except IndexError:
|
||||
raise MediaNotFoundError("Album cannot be found")
|
||||
|
||||
def _search_playlists(self, title: str):
|
||||
"""
|
||||
Search the Plex music db for playlist
|
||||
|
||||
Args:
|
||||
title: str title of playlist to search for
|
||||
|
||||
Returns:
|
||||
plexapi.playlist pointing to best matching title
|
||||
|
||||
Raises:
|
||||
MediaNotFoundError: Title of playlist can't be found in plex db
|
||||
"""
|
||||
try:
|
||||
return self.pms.playlist(title)
|
||||
except NotFound:
|
||||
raise MediaNotFoundError("Playlist cannot be found")
|
||||
|
||||
def _get_playlists(self):
|
||||
"""
|
||||
Search the Plex music db for playlist
|
||||
|
||||
Returns:
|
||||
List of plexapi.playlist
|
||||
"""
|
||||
return self.pms.playlists()
|
||||
|
||||
async def _play(self):
|
||||
"""
|
||||
Heavy lifting of playing songs
|
||||
"""Heavy lifting of playing songs
|
||||
|
||||
Grabs the appropiate streaming URL, sends the `now playing`
|
||||
message, and initiates playback in the vc.
|
||||
@ -304,45 +255,18 @@ class Plex(commands.Cog):
|
||||
track_url = self.current_track.getStreamURL()
|
||||
audio_stream = FFmpegPCMAudio(track_url)
|
||||
|
||||
while self.voice_channel and self.voice_channel.is_playing():
|
||||
bot_log.debug("waiting for track to finish")
|
||||
await asyncio.sleep(2)
|
||||
bot_log.debug("track finished")
|
||||
while self.voice_channel.is_playing():
|
||||
asyncio.sleep(2)
|
||||
|
||||
if self.voice_channel:
|
||||
self.voice_channel.play(audio_stream, after=self._toggle_next)
|
||||
self.voice_channel.play(audio_stream, after=self._toggle_next)
|
||||
|
||||
plex_log.debug("%s - URL: %s", self.current_track, track_url)
|
||||
plex_log.debug("%s - URL: %s", self.current_track, track_url)
|
||||
|
||||
embed, img = self._build_embed_track(self.current_track)
|
||||
self.np_message_id = await self.ctx.send(embed=embed, file=img)
|
||||
|
||||
async def _play_next(self):
|
||||
try:
|
||||
from asyncio.exceptions import CancelledError
|
||||
except ImportError:
|
||||
from concurrent.futures._base import CancelledError
|
||||
if self.is_looping:
|
||||
self.current_track = self.is_looping
|
||||
else:
|
||||
try:
|
||||
self.current_track = await self.play_queue.get()
|
||||
except CancelledError:
|
||||
bot_log.debug("failed to pop queue")
|
||||
|
||||
if not self.current_track and self.loop_queue:
|
||||
bot_log.debug("swapping loop queue and play queue")
|
||||
for item in self.loop_queue:
|
||||
await self.play_queue.put(item)
|
||||
|
||||
try:
|
||||
self.current_track = await self.play_queue.get()
|
||||
except CancelledError:
|
||||
bot_log.debug("failed to pop queue")
|
||||
embed, img = self._build_embed_track(self.current_track)
|
||||
self.np_message_id = await self.ctx.send(embed=embed, file=img)
|
||||
|
||||
async def _audio_player_task(self):
|
||||
"""
|
||||
Coroutine to handle playback and queuing
|
||||
"""Coroutine to handle playback and queuing
|
||||
|
||||
Always-running function awaiting new songs to be added.
|
||||
Auto disconnects from VC if idle for > 15 seconds.
|
||||
@ -363,23 +287,20 @@ class Plex(commands.Cog):
|
||||
try:
|
||||
# Disconnect after 15 seconds idle
|
||||
async with timeout(15):
|
||||
await self._play_next()
|
||||
self.current_track = await self.play_queue.get()
|
||||
except asyncio.TimeoutError:
|
||||
bot_log("timeout - disconnecting")
|
||||
await self.voice_channel.disconnect()
|
||||
self.voice_channel = None
|
||||
|
||||
if not self.current_track:
|
||||
await self._play_next()
|
||||
self.current_track = await self.play_queue.get()
|
||||
|
||||
await self._play()
|
||||
await self.play_next_event.wait()
|
||||
if self.np_message_id:
|
||||
await self.np_message_id.delete()
|
||||
await self.np_message_id.delete()
|
||||
|
||||
def _toggle_next(self, error=None):
|
||||
"""
|
||||
Callback for vc playback
|
||||
"""Callback for vc playback
|
||||
|
||||
Clears current track, then activates _audio_player_task
|
||||
to play next in queue or disconnect.
|
||||
@ -398,8 +319,7 @@ class Plex(commands.Cog):
|
||||
|
||||
@staticmethod
|
||||
def _build_embed_track(track, type_="play"):
|
||||
"""
|
||||
Creates a pretty embed card for tracks
|
||||
"""Creates a pretty embed card for tracks
|
||||
|
||||
Builds a helpful status embed with the following info:
|
||||
Status, song title, album, artist and album art. All
|
||||
@ -417,22 +337,16 @@ class Plex(commands.Cog):
|
||||
ValueError: Unsupported type of embed {type_}
|
||||
"""
|
||||
# Grab the relevant thumbnail
|
||||
if track.thumbUrl:
|
||||
img_stream = requests.get(track.thumbUrl, stream=True).raw
|
||||
img = io.BytesIO(img_stream.read())
|
||||
|
||||
# Attach to discord embed
|
||||
art_file = discord.File(img, filename="image0.png")
|
||||
else:
|
||||
art_file = None
|
||||
img_stream = urlopen(track.thumbUrl)
|
||||
img = io.BytesIO(img_stream.read())
|
||||
|
||||
# Attach to discord embed
|
||||
art_file = discord.File(img, filename="image0.png")
|
||||
# Get appropiate status message
|
||||
if type_ == "play":
|
||||
title = f"Now Playing - {track.title}"
|
||||
elif type_ == "queue":
|
||||
title = f"Added to queue - {track.title}"
|
||||
elif type_ == "queued":
|
||||
title = f"Next in line - {track.title}"
|
||||
else:
|
||||
raise ValueError(f"Unsupported type of embed {type_}")
|
||||
|
||||
@ -453,8 +367,7 @@ class Plex(commands.Cog):
|
||||
|
||||
@staticmethod
|
||||
def _build_embed_album(album):
|
||||
"""
|
||||
Creates a pretty embed card for albums
|
||||
"""Creates a pretty embed card for albums
|
||||
|
||||
Builds a helpful status embed with the following info:
|
||||
album, artist, and album art. All pertitent information
|
||||
@ -471,7 +384,7 @@ class Plex(commands.Cog):
|
||||
None
|
||||
"""
|
||||
# Grab the relevant thumbnail
|
||||
img_stream = requests.get(album.thumbUrl, stream=True).raw
|
||||
img_stream = urlopen(album.thumbUrl)
|
||||
img = io.BytesIO(img_stream.read())
|
||||
|
||||
# Attach to discord embed
|
||||
@ -488,47 +401,8 @@ class Plex(commands.Cog):
|
||||
|
||||
return embed, art_file
|
||||
|
||||
@staticmethod
|
||||
def _build_embed_playlist(self, playlist, title, descrip):
|
||||
"""
|
||||
Creates a pretty embed card for playlists
|
||||
|
||||
Builds a helpful status embed with the following info:
|
||||
playlist art. All pertitent information
|
||||
is grabbed dynamically from the Plex db.
|
||||
|
||||
Args:
|
||||
playlist: plexapi.playlist object of playlist
|
||||
|
||||
Returns:
|
||||
embed: discord.embed fully constructed payload.
|
||||
thumb_art: io.BytesIO of playlist thumbnail img.
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
# Grab the relevant thumbnail
|
||||
try:
|
||||
img_stream = requests.get(self.pms.url(playlist.composite, True), stream=True).raw
|
||||
img = io.BytesIO(img_stream.read())
|
||||
except:
|
||||
raise MediaNotFoundError("no image available")
|
||||
|
||||
# Attach to discord embed
|
||||
art_file = discord.File(img, filename="image0.png")
|
||||
|
||||
embed = discord.Embed(
|
||||
title=title, description=descrip, colour=discord.Color.red()
|
||||
)
|
||||
embed.set_author(name="Plex")
|
||||
embed.set_thumbnail(url="attachment://image0.png")
|
||||
bot_log.debug("Built embed for playlist - %s", playlist.title)
|
||||
|
||||
return embed, art_file
|
||||
|
||||
async def _validate(self, ctx):
|
||||
"""
|
||||
Ensures user is in a vc
|
||||
"""Ensures user is in a vc
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -547,16 +421,12 @@ class Plex(commands.Cog):
|
||||
|
||||
# Connect to voice if not already
|
||||
if not self.voice_channel:
|
||||
try:
|
||||
self.voice_channel = await ctx.author.voice.channel.connect()
|
||||
bot_log.debug("Connected to vc.")
|
||||
except asyncio.exceptions.TimeoutError:
|
||||
bot_log.debug("Cannot connect to vc - timeout")
|
||||
self.voice_channel = await ctx.author.voice.channel.connect()
|
||||
bot_log.debug("Connected to vc.")
|
||||
|
||||
@command()
|
||||
async def play(self, ctx, *args):
|
||||
"""
|
||||
User command to play song
|
||||
"""User command to play song
|
||||
|
||||
Searchs plex db and either, initiates playback, or
|
||||
adds to queue. Handles invalid usage from the user.
|
||||
@ -588,7 +458,7 @@ class Plex(commands.Cog):
|
||||
pass
|
||||
|
||||
# Specific add to queue message
|
||||
if self.voice_channel and self.voice_channel.is_playing():
|
||||
if self.voice_channel.is_playing():
|
||||
bot_log.debug("Added to queue - %s", title)
|
||||
embed, img = self._build_embed_track(track, type_="queue")
|
||||
await ctx.send(embed=embed, file=img)
|
||||
@ -598,8 +468,7 @@ class Plex(commands.Cog):
|
||||
|
||||
@command()
|
||||
async def album(self, ctx, *args):
|
||||
"""
|
||||
User command to play song
|
||||
"""User command to play song
|
||||
|
||||
Searchs plex db and either, initiates playback, or
|
||||
adds to queue. Handles invalid usage from the user.
|
||||
@ -637,124 +506,9 @@ class Plex(commands.Cog):
|
||||
for track in album.tracks():
|
||||
await self.play_queue.put(track)
|
||||
|
||||
async def play_playlist(self, title, shuffle=False):
|
||||
try:
|
||||
playlist = self._search_playlists(title)
|
||||
except MediaNotFoundError:
|
||||
await self.ctx.send(f"Can't find playlist: {title}")
|
||||
bot_log.debug("Failed to queue playlist, can't find - %s", title)
|
||||
return
|
||||
|
||||
try:
|
||||
await self._validate(self.ctx)
|
||||
except VoiceChannelError:
|
||||
pass
|
||||
|
||||
try:
|
||||
embed, img = self._build_embed_playlist(self, playlist, "Added playlist to queue", playlist.title)
|
||||
await self.ctx.send(embed=embed, file=img)
|
||||
|
||||
items = [ item for item in playlist.items() if item.TYPE == "track" ]
|
||||
if shuffle:
|
||||
from random import shuffle
|
||||
shuffle(items)
|
||||
|
||||
for item in items:
|
||||
await self.play_queue.put(item)
|
||||
|
||||
bot_log.debug("Added to queue - %s", title)
|
||||
|
||||
except MediaNotFoundError:
|
||||
await self.ctx.send(message="Playlist "+title+" seems to be empty!")
|
||||
bot_log.debug("Playlist empty - %s", title)
|
||||
|
||||
@command()
|
||||
async def playlist(self, ctx, *args):
|
||||
"""
|
||||
User command to play playlist
|
||||
|
||||
Searchs plex db and either, initiates playback, or
|
||||
adds to queue. Handles invalid usage from the user.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
*args: Title of playlist to play
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
# Save the context to use with async callbacks
|
||||
self.ctx = ctx
|
||||
title = " ".join(args)
|
||||
await self.play_playlist(title)
|
||||
|
||||
@command()
|
||||
async def playlist_shuffle(self, ctx, *args):
|
||||
"""
|
||||
User command to play playlist in shuffle mode
|
||||
|
||||
Searchs plex db and either, initiates playback, or
|
||||
adds to queue. Handles invalid usage from the user.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
*args: Title of playlist to play
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
# Save the context to use with async callbacks
|
||||
self.ctx = ctx
|
||||
title = " ".join(args)
|
||||
await self.play_playlist(title,shuffle=True)
|
||||
|
||||
|
||||
@command()
|
||||
async def show_playlists(self, ctx, *args):
|
||||
"""
|
||||
User command to show playlists
|
||||
|
||||
Searchs plex db and shows playlists matching.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
*args: String filter for playlist names
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
# Save the context to use with async callbacks
|
||||
self.ctx = ctx
|
||||
|
||||
playlists = self._get_playlists()
|
||||
|
||||
try:
|
||||
await self._validate(ctx)
|
||||
except VoiceChannelError:
|
||||
pass
|
||||
|
||||
for playlist in playlists:
|
||||
if args and not any(arg in playlist.title for arg in args):
|
||||
continue
|
||||
from datetime import timedelta
|
||||
if playlist.duration:
|
||||
seconds = playlist.duration / 1000
|
||||
embed, img = self._build_embed_playlist(self, playlist, playlist.title, "{:0>8}".format(str(timedelta(seconds=seconds))))
|
||||
await ctx.send(embed=embed, file=img)
|
||||
|
||||
@command()
|
||||
async def stop(self, ctx):
|
||||
"""
|
||||
User command to stop playback
|
||||
"""User command to stop playback
|
||||
|
||||
Stops playback and disconnects from vc.
|
||||
|
||||
@ -775,84 +529,9 @@ class Plex(commands.Cog):
|
||||
bot_log.debug("Stopped")
|
||||
await ctx.send(":stop_button: Stopped")
|
||||
|
||||
@command()
|
||||
async def loop(self, ctx):
|
||||
"""
|
||||
User command to activate looping the current track
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
bot_log.debug("Looping "+str(self.current_track))
|
||||
self.is_looping = self.current_track
|
||||
|
||||
@command()
|
||||
async def loopq(self, ctx):
|
||||
"""
|
||||
User command to activate looping the current queue
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
bot_log.debug("Looping current queue")
|
||||
if self.current_track:
|
||||
self.loop_queue = [ self.current_track ]
|
||||
else:
|
||||
self.loop_queue = []
|
||||
for item in self.play_queue._queue:
|
||||
self.loop_queue.append(item)
|
||||
|
||||
@command()
|
||||
async def unloop(self, ctx):
|
||||
"""
|
||||
User command to deactivate looping the current track
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
bot_log.debug("Looping current queue")
|
||||
self.is_looping = False
|
||||
|
||||
@command()
|
||||
async def unloopq(self, ctx):
|
||||
"""
|
||||
User command to deactivate looping the current queue
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
bot_log.debug("Unlooping")
|
||||
self.loop_queue = None
|
||||
|
||||
|
||||
@command()
|
||||
async def pause(self, ctx):
|
||||
"""
|
||||
User command to pause playback
|
||||
"""User command to pause playback
|
||||
|
||||
Pauses playback, but doesn't reset anything
|
||||
to allow playback resuming.
|
||||
@ -873,8 +552,7 @@ class Plex(commands.Cog):
|
||||
|
||||
@command()
|
||||
async def resume(self, ctx):
|
||||
"""
|
||||
User command to resume playback
|
||||
"""User command to resume playback
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -891,9 +569,8 @@ class Plex(commands.Cog):
|
||||
await ctx.send(":play_pause: Resumed")
|
||||
|
||||
@command()
|
||||
async def skip(self, ctx, *args):
|
||||
"""
|
||||
User command to skip song in queue
|
||||
async def skip(self, ctx):
|
||||
"""User command to skip song in queue
|
||||
|
||||
Skips currently playing song. If no other songs in
|
||||
queue, stops playback, otherwise moves to next song.
|
||||
@ -907,22 +584,15 @@ class Plex(commands.Cog):
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
n = 1
|
||||
if args:
|
||||
n = int(args[0])
|
||||
bot_log.debug("Skipping "+str(n))
|
||||
bot_log.debug("Skip")
|
||||
if self.voice_channel:
|
||||
self.voice_channel.stop()
|
||||
bot_log.debug("Skipped")
|
||||
if n>1:
|
||||
for i in range(n-1):
|
||||
await self.play_queue.get()
|
||||
self._toggle_next()
|
||||
|
||||
@command(name="np")
|
||||
async def now_playing(self, ctx):
|
||||
"""
|
||||
User command to get currently playing song.
|
||||
"""User command to get currently playing song.
|
||||
|
||||
Deletes old `now playing` status message,
|
||||
Creates a new one with up to date information.
|
||||
@ -937,55 +607,18 @@ class Plex(commands.Cog):
|
||||
None
|
||||
"""
|
||||
if self.current_track:
|
||||
embed, img = self._build_embed_track(self.current_track,type_="play")
|
||||
embed, img = self._build_embed_track(self.current_track)
|
||||
bot_log.debug("Now playing")
|
||||
if self.np_message_id:
|
||||
try:
|
||||
await self.np_message_id.delete()
|
||||
bot_log.debug("Deleted old np status")
|
||||
except discord.errors.NotFound:
|
||||
pass
|
||||
await self.np_message_id.delete()
|
||||
bot_log.debug("Deleted old np status")
|
||||
|
||||
bot_log.debug("Created np status")
|
||||
self.np_message_id = await ctx.send(embed=embed, file=img)
|
||||
|
||||
@command(name="q")
|
||||
async def show_queue(self, ctx):
|
||||
"""
|
||||
User command to print the current queue
|
||||
|
||||
Deletes old `now playing` status message,
|
||||
Creates a new one with up to date information.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
Returns:
|
||||
None
|
||||
|
||||
Raises:
|
||||
None
|
||||
"""
|
||||
bot_log.debug("Deleted old queue messages")
|
||||
for msg in self.show_queue_message_ids:
|
||||
await msg.delete()
|
||||
|
||||
# need to do this in order to avoid errors when queue is modified during inspection
|
||||
elems = []
|
||||
for track in self.play_queue._queue:
|
||||
elems.append(track)
|
||||
|
||||
for track in elems:
|
||||
embed, img = self._build_embed_track(track,type_="queued")
|
||||
bot_log.debug("Show queue")
|
||||
|
||||
bot_log.debug("Created queue message")
|
||||
self.show_queue_message_ids.append(await ctx.send(embed=embed, file=img))
|
||||
|
||||
@command()
|
||||
async def clear(self, ctx):
|
||||
"""
|
||||
User command to clear play queue.
|
||||
"""User command to clear play queue.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
@ -997,14 +630,12 @@ class Plex(commands.Cog):
|
||||
None
|
||||
"""
|
||||
self.play_queue = asyncio.Queue()
|
||||
self.loop_queue = None
|
||||
bot_log.debug("Cleared queue")
|
||||
await ctx.send(":boom: Queue cleared.")
|
||||
|
||||
@command()
|
||||
async def lyrics(self, ctx):
|
||||
"""
|
||||
User command to get lyrics of a song.
|
||||
"""User command to get lyrics of a song.
|
||||
|
||||
Args:
|
||||
ctx: discord.ext.commands.Context message context from command
|
||||
|
||||
@ -63,9 +63,6 @@ Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-
|
||||
token: "<PLEX_TOKEN>"
|
||||
library_name: "<LIBRARY_NAME>"
|
||||
log_level: "debug"
|
||||
|
||||
lyrics:
|
||||
token: "none" # Add your token here if you enable lyrics
|
||||
```
|
||||
|
||||
4. Create a Discord bot application:
|
||||
@ -94,6 +91,8 @@ Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-
|
||||
|
||||
6. Get your Lyrics Genius token (Optional):
|
||||
|
||||
If you wanty to disable this feature, set token to `None` in `config/config.yaml`
|
||||
|
||||
If you would like to enable the lyrics feature of the bot, you need to signup for a free GeniusLyrics account, [here](https://genius.com/api-clients).
|
||||
|
||||
After you make an account:
|
||||
@ -104,7 +103,7 @@ Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-
|
||||
|
||||
3. Set the redirect url to: `http://localhost`
|
||||
|
||||
4. Copy the **Client Access Token** and replace `None` with your token in `config/config.yaml`
|
||||
4. Copy the **Client Access Token** to `config/config.yaml`
|
||||
|
||||
7. Customize remaining settings
|
||||
|
||||
@ -138,7 +137,6 @@ General:
|
||||
Plex:
|
||||
play <SONG_NAME> - Play a song from the plex server.
|
||||
album <ALBUM_NAME> - Queue an entire album to play.
|
||||
playlist <PLAYLIST_NAME> - Queue an entire playlist to play.
|
||||
lyrics - Print the lyrics of the song (Requires Genius API)
|
||||
np - Print the current playing song.
|
||||
stop - Halt playback and leave vc.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user