Skip to content

Commit b7cd610

Browse files
authored
Update README.md
1 parent 1d949a8 commit b7cd610

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Discord Radio Bot
22

3-
A simple Discord bot that streams radio stations in voice channels and updates its status with the current song title. This bot can join a voice channel, play a specified radio stream, adjust volume, and provide a custom help command for bot commands. It integrates with Discord Rich Presence to display the currently playing song.
3+
A simple Discord bot that streams radio stations in voice channels and updates its status with the current song title. This bot can join a voice channel, play a specified radio stream, adjust volume, and provide a custom help command for bot commands. It integrates with Discord Rich Presence to display the currently playing song and features automatic recovery from disconnections.
44

55
## Features
66

77
- **Stream Radio**: Plays a specified radio stream in a voice channel.
88
- **Volume Control**: Adjusts playback volume with a simple command.
99
- **Custom Help Command**: Provides a list of available commands with a user-friendly interface.
1010
- **Discord Rich Presence**: Displays the current song title in Discord Rich Presence.
11-
- **Automatic Presence Update**: Updates Rich Presence every 30 seconds with the current song title.
11+
- **Automatic Presence Update**: Updates Rich Presence every 120 seconds with the current song title.
1212
- **Role-based Permissions**: Commands are restricted to users with specific roles.
1313
- **Channel Restriction**: Commands can only be used in a designated control channel.
1414
- **Join and Leave Voice Channels**: Commands to join or leave voice channels.
@@ -17,6 +17,11 @@ A simple Discord bot that streams radio stations in voice channels and updates i
1717
- **Update Default Stream URL**: Change the default stream URL used by the bot.
1818
- **Add and List Radio Stations**: Add new radio stations to the configuration and list available stations.
1919
- **Fetch Cover Image**: Fetches cover images from Spotify for the currently playing track.
20+
- **Auto-Reconnect**: Automatically reconnects and resumes playback when disconnected.
21+
- **Stream State Management**: Maintains stream state across channel moves and reconnections.
22+
- **Enhanced Error Handling**: Better error feedback and recovery mechanisms.
23+
- **Automatic Stream Recovery**: Recovers stream playback when moved between channels.
24+
- **Dynamic Nickname Updates**: Updates bot nickname to reflect current station.
2025

2126
## Commands
2227

@@ -26,14 +31,15 @@ A simple Discord bot that streams radio stations in voice channels and updates i
2631
- `!stop`: Stops the playback.
2732
- `!vol <volume>`: Adjusts the playback volume (0-100).
2833
- `!setdefault <url>`: Updates the default stream URL in the configuration.
29-
- `!stations`: Displays a list of available radio stations with indices.
34+
- `!radio`: Shows an interactive menu of available radio stations.
3035
- `!add <name> <url>`: Adds a new radio station to the configuration.
31-
- `!remove`: Removes a radio station from the configuration file.
36+
- `!remove`: Shows an interactive menu to remove radio stations.
3237
- `!restart`: Restarts the bot.
3338
- `!reload`: Reloads the configuration file.
3439
- `!commands`: Displays the list of available commands.
3540
- `!status`: Shows the current station and playing title.
3641
- `!stats`: Shows bot statistics.
42+
- `!fix`: Fixes stream playback issues by restarting the current stream.
3743

3844
## Setup
3945

@@ -98,15 +104,25 @@ To run the bot using Docker, follow these steps:
98104

99105
This will create and run a Docker container with your bot, including FFmpeg for streaming.
100106

101-
## Rich Presence
107+
## Rich Presence and Status Updates
102108

103-
The bot uses Discord Rich Presence to show the current song title. Ensure that the `client_id` in your `config.ini` is set correctly for Rich Presence to work.
109+
The bot uses Discord Rich Presence to show the current song title and updates its status every 120 seconds. It also maintains a dedicated update channel where it posts currently playing tracks with cover art from Spotify.
110+
111+
## New Features in v1.1.1
112+
113+
- **Auto-Reconnect**: Bot now automatically reconnects when disconnected
114+
- **Stream Recovery**: Maintains playback state when moved between channels
115+
- **Enhanced Stability**: Better error handling and recovery mechanisms
116+
- **Interactive Menus**: New dropdown and button interfaces for station selection
117+
- **Improved Status Updates**: More reliable song title and cover art updates
104118

105119
## Troubleshooting
106120

107121
- **Bot not updating Rich Presence**: Ensure that Discord is running and that you have set the correct `client_id` in `config.ini`.
108122
- **Bot not joining the voice channel**: Verify that the bot has the necessary permissions and that the `default_voice_channel_id` is correct.
123+
- **Stream interruptions**: Use the `!fix` command to restart the current stream if you experience playback issues.
109124
- **Error installing dependencies**: Ensure you have Python 3.11 or later and that `ffmpeg` is properly installed.
125+
- **Bot disconnecting**: The bot will now automatically attempt to reconnect and resume playback.
110126

111127
## Contributing
112128

0 commit comments

Comments
 (0)