You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+42-12
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Plex Music Bot (BETA) v0.5
1
+
# Plex Music Bot (BETA) v0.6
2
2
This Discord bot allows users to play audio from their Plex library and YouTube videos in a voice channel.
3
3

4
4
@@ -23,16 +23,14 @@ This Discord bot allows users to play audio from their Plex library and YouTube
23
23
24
24
-`!playlist`: List all available playlists and play songs from the chosen playlist by selecting its number.
25
25
(This is one of the most powerful commands because you can setup playlists in Plex then quickly start playing them.)
26
-
(Some issues I have with this command are songs repeating until they get skipped not sure why yet. I may make it so they get shuffled)
27
26
28
-
-`!show_queue`: Display the current song queue with song titles and artists.
27
+
-`!queue`: Display the current song queue with song titles and artists.
29
28
30
29
-`!shuffle`: Randomly shuffle the current song queue.
31
30
32
31
-`!artist <artist name>`: Queue all songs by the specified artist from your Plex library.
33
32
34
33
-`!skip`: Skip the current song and play the next song in the queue.
35
-
(I am having a strange issue where it will skip the song but then the next song after that gets added to the bottom of the queue)
36
34
37
35
-`!youtube <YouTube URL or search query>`: Play audio from a YouTube video using its URL, or search for a video or playlist and play the first result.
38
36
(Youtube search is very slow and buggy. providing a link is the best option. Playlists are currently broken dont try to play them.)
@@ -44,9 +42,10 @@ This Discord bot allows users to play audio from their Plex library and YouTube
44
42
-`!help <command>`: Show more detailed information on a specific command.
45
43
46
44
# Prerequisites
47
-
Python 3.11 or higher
45
+
Python 3.11.2 or higher
48
46
A Discord bot token
49
47
A Plex server with valid credentials
48
+
(I have moved to using a plex token and base-url for cridentials. I have left the option to login using username and password you just have to uncomment it.)
50
49
51
50
# Installation
52
51
Clone this repository or download it as a ZIP file and extract it.
Change the working directory to the project folder:
73
+
74
+
- cd plex_music_bot
75
+
76
+
- Build the Docker image:
77
+
Copy code
78
+
docker build -t plex_music_bot .
79
+
80
+
- Run the Docker container
81
+
82
+
docker run -d --name plex_music_bot
67
83
68
-
1. Install ffmpeg. Depending on your operating system, you may be able to install ffmpeg using your package manager. For example, on Ubuntu or Debian, you can run 'sudo apt-get install ffmpeg' to install ffmpeg. On macOS, you can use Homebrew by running 'brew install ffmpeg'.
84
+
#Install the required dependencies.
69
85
70
-
2. Install the Python dependencies by running pip install -r requirements.txt.
86
+
pip install -r requirements.txt
71
87
72
-
3. Enter your credentials into config.py or set them as environment variables.
88
+
Install ffmpeg. Depending on your operating system, you may be able to install ffmpeg using your package manager. For example, on Ubuntu or Debian, you can run 'sudo apt-get install ffmpeg' to install ffmpeg. On macOS, you can use Homebrew by running 'brew install ffmpeg'.
73
89
90
+
Enter your cridentials into config.py or use environment variables.
74
91
75
92
# Environment Variables
76
93
(This is optional if you use the config.py you dont need to do this)
@@ -126,9 +143,22 @@ Restart the bot by stopping the current instance and running it again.
126
143
127
144
python plex_music_bot.py
128
145
146
+
Using Docker:
147
+
Rebuild the Docker image:
148
+
149
+
docker build -t plex_music_bot .
150
+
Stop the running container:
151
+
152
+
docker stop plex_music_bot
153
+
Remove the stopped container:
154
+
155
+
docker rm plex_music_bot
156
+
Run the updated Docker container:
157
+
158
+
docker run -d --name plex_music_bot
159
+
129
160
# Contributing
130
161
Feel free to submit issues, feature requests, or pull requests to contribute to this project.
0 commit comments