diff --git a/README.md b/README.md index f699515..a0a422c 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,28 @@ ![GitHub](https://img.shields.io/github/license/EnderIce2/SDR-RPC) ![GitHub All Releases](https://img.shields.io/github/downloads/EnderIce2/SDR-RPC/total) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/EnderIce2/SDR-RPC) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/800cd7ade7ab4aa386f79b5c999a2959)](https://app.codacy.com/gh/EnderIce2/SDR-RPC?utm_source=github.com&utm_medium=referral&utm_content=EnderIce2/SDR-RPC&utm_campaign=Badge_Grade_Settings) -[![CodeFactor](https://www.codefactor.io/repository/github/enderice2/sdr-rpc/badge?s=6ea1f91b515716a019633ad07f7d3138bc136f22)](https://www.codefactor.io/repository/github/enderice2/sdr-rpc) -[![Twitter Follow](https://img.shields.io/twitter/follow/enderice22?style=social)](https://twitter.com/intent/follow?screen_name=enderice22) # SDR-RPC -SDR-RPC is an [SDRSharp](https://airspy.com/download/) plugin that adds Discord RPC feature in it +**SDR-RPC** is a plugin for [SDRSharp](https://airspy.com/download/) that integrates Discord Rich Presence (RPC) to provide live updates about your SDRSharp activities directly in Discord. --- -### ✨Features -- 🎛Enable / Disable -- ✏Showing frequency, play state and RDS almost in realtime -- 🔌Most of the code is made asynchronous -- 📖Logging for troubleshooting problems -- 🔨Easy to install +## ✨Features +- ✏Displays **frequency, playback state, and RDS information** +- 🔌Optimized with **asynchronous code** for smoother performance +- 📖**Logging** to help troubleshoot issues +- 🔨**Simple installation** process ---- +## 🎁How to install + Demo -### 🎁How to install +📽**Watch the video:** -📽Video: +[![](http://img.youtube.com/vi/OOnt8ytrDc0/0.jpg)](https://youtu.be/OOnt8ytrDc0 "") -[![](http://img.youtube.com/vi/Otn-xSn_ioI/0.jpg)](http://www.youtube.com/watch?v=Otn-xSn_ioI "") +## 💻Building from Source ---- - -### 🎫Example - -📽Video: - -[![](http://img.youtube.com/vi/7k02dPqAjBA/0.jpg)](http://www.youtube.com/watch?v=7k02dPqAjBA "") - ---- - -### 💻Building by yourself - -1. You need to download this stuff before compiling: +### Prerequisites +Before you start, ensure you have the following: - [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) - [.NET 4.6](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer) - [SDRSharp Plugin SDK](https://airspy.com/?ddownload=5944) @@ -45,40 +30,44 @@ SDR-RPC is an [SDRSharp](https://airspy.com/download/) plugin that adds Discord - SDRSharp.PanView.dll - SDRSharp.Radio.dll -2. Click "Code" and select "Open with Visual Studio" or "Download ZIP" +### Steps + +1. Clone the repository or download it as a ZIP file. + - To clone: Click **Code** and select "Open with Visual Studio". + - To download: Select "Download ZIP", extract the archive, and open `SDRSharpPlugin.DiscordRPC.sln`. ![Captură de ecran 2020-10-26 025111.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20025111.png) -3. If you downloaded as ZIP, unzip the archive and double click on "SDRSharpPlugin.DiscordRPC.sln" -4. Build it and move files to SDR# location (if the compile fails try copying Reference files into /bin/Debug or /bin/Release folder) +2. Build the solution in Visual Studio. + - If compilation fails, try moving reference files to the `/bin/Debug` or `/bin/Release` folder. ---- +3. Copy the compiled files to the SDR# installation directory. -### 👀Setting your custom images on RPC +## 👀Customizing RPC Images -1. Go to https://discord.com/developers/applications and create your own application -2. Name it "SDRSharp" or something similar +1. Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application. + - Name it “SDRSharp” or something similar. -![Captură de ecran 2020-10-26 023639.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023639.png) +![2024-11-27_02-35](https://github.com/user-attachments/assets/38eb265d-1617-470d-9804-de7cd48323ab) -3. Go to Rich Presence > Rich Presence Assets and add your own images with these names: +2. Navigate to **Rich Presence > Assets** and upload your images. + - Use descriptive names for easy reference. -![Captură de ecran 2020-10-26 023706.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023706.png) +![2024-11-27_02-35_1](https://github.com/user-attachments/assets/1ac8743b-e645-4e57-a3de-2170353fe7f7) -4. Go back to General Information and copy Client ID +3. Go to **General Information** and copy the **Client ID**. ![Captură de ecran 2020-10-26 023915.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023915.png) -5. Paste the Client ID you copied earlier in plugin textbox from SDRSharp and press the ENTER key +4. Paste the Client ID into the plugin textbox in SDRSharp and press **ENTER**. ![Captură de ecran 2020-10-26 024024.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20024024.png) -6. Restart the SDRSharp and it should be changed with your custom images +5. Restart SDRSharp. Your custom images will now appear in Discord. ---- - -### 📕TODO List +## 📕Roadmap +### Planned Features - Invite people to get Spy Server Address or connecting via voice chat system to listen and having the ability to change the frequency - Change Settings Panel to match SDR# theme - Show "Listening" instead of "Playing"