Skip to content

Commit a1bbdfc

Browse files
authored
Update README.md
Related to #14
1 parent 139af9b commit a1bbdfc

File tree

1 file changed

+32
-43
lines changed

1 file changed

+32
-43
lines changed

README.md

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,73 @@
11
![GitHub](https://img.shields.io/github/license/EnderIce2/SDR-RPC)
22
![GitHub All Releases](https://img.shields.io/github/downloads/EnderIce2/SDR-RPC/total)
33
![GitHub release (latest by date)](https://img.shields.io/github/v/release/EnderIce2/SDR-RPC)
4-
[![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)
5-
[![CodeFactor](https://www.codefactor.io/repository/github/enderice2/sdr-rpc/badge?s=6ea1f91b515716a019633ad07f7d3138bc136f22)](https://www.codefactor.io/repository/github/enderice2/sdr-rpc)
6-
[![Twitter Follow](https://img.shields.io/twitter/follow/enderice22?style=social)](https://twitter.com/intent/follow?screen_name=enderice22)
74
# SDR-RPC
85

9-
SDR-RPC is an [SDRSharp](https://airspy.com/download/) plugin that adds Discord RPC feature in it
6+
**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.
107

118
---
129

13-
### ✨Features
14-
- 🎛Enable / Disable
15-
- ✏Showing frequency, play state and RDS almost in realtime
16-
- 🔌Most of the code is made asynchronous
17-
- 📖Logging for troubleshooting problems
18-
- 🔨Easy to install
10+
## ✨Features
11+
- ✏Displays **frequency, playback state, and RDS information**
12+
- 🔌Optimized with **asynchronous code** for smoother performance
13+
- 📖**Logging** to help troubleshoot issues
14+
- 🔨**Simple installation** process
1915

20-
---
21-
22-
### 🎁How to install
16+
## 🎁How to install + Demo
2317

24-
📽Video:
18+
📽**Watch the video:**
2519

26-
[![](http://img.youtube.com/vi/Otn-xSn_ioI/0.jpg)](http://www.youtube.com/watch?v=Otn-xSn_ioI "")
27-
28-
---
20+
[![](http://img.youtube.com/vi/OOnt8ytrDc0/0.jpg)](https://youtu.be/OOnt8ytrDc0 "")
2921

30-
### 🎫Example
22+
## 💻Building from Source
3123

32-
📽Video:
33-
34-
[![](http://img.youtube.com/vi/7k02dPqAjBA/0.jpg)](http://www.youtube.com/watch?v=7k02dPqAjBA "")
35-
36-
---
37-
38-
### 💻Building by yourself
39-
40-
1. You need to download this stuff before compiling:
24+
### Prerequisites
25+
Before you start, ensure you have the following:
4126
- [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
4227
- [.NET 4.6](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer)
4328
- [SDRSharp Plugin SDK](https://airspy.com/?ddownload=5944)
4429
- SDRSharp.Common.dll
4530
- SDRSharp.PanView.dll
4631
- SDRSharp.Radio.dll
4732

48-
2. Click "Code" and select "Open with Visual Studio" or "Download ZIP"
33+
### Steps
34+
35+
1. Clone the repository or download it as a ZIP file.
36+
- To clone: Click **Code** and select "Open with Visual Studio".
37+
- To download: Select "Download ZIP", extract the archive, and open `SDRSharpPlugin.DiscordRPC.sln`.
4938

5039
![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)
5140

52-
3. If you downloaded as ZIP, unzip the archive and double click on "SDRSharpPlugin.DiscordRPC.sln"
53-
4. Build it and move files to SDR# location (if the compile fails try copying Reference files into /bin/Debug or /bin/Release folder)
41+
2. Build the solution in Visual Studio.
42+
- If compilation fails, try moving reference files to the `/bin/Debug` or `/bin/Release` folder.
5443

55-
---
44+
3. Copy the compiled files to the SDR# installation directory.
5645

57-
### 👀Setting your custom images on RPC
46+
## 👀Customizing RPC Images
5847

59-
1. Go to https://discord.com/developers/applications and create your own application
60-
2. Name it "SDRSharp" or something similar
48+
1. Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
49+
- Name it SDRSharp or something similar.
6150

62-
![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)
51+
![2024-11-27_02-35](https://github.com/user-attachments/assets/38eb265d-1617-470d-9804-de7cd48323ab)
6352

64-
3. Go to Rich Presence > Rich Presence Assets and add your own images with these names:
53+
2. Navigate to **Rich Presence > Assets** and upload your images.
54+
- Use descriptive names for easy reference.
6555

66-
![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)
56+
![2024-11-27_02-35_1](https://github.com/user-attachments/assets/1ac8743b-e645-4e57-a3de-2170353fe7f7)
6757

68-
4. Go back to General Information and copy Client ID
58+
3. Go to **General Information** and copy the **Client ID**.
6959

7060
![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)
7161

72-
5. Paste the Client ID you copied earlier in plugin textbox from SDRSharp and press the ENTER key
62+
4. Paste the Client ID into the plugin textbox in SDRSharp and press **ENTER**.
7363

7464
![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)
7565

76-
6. Restart the SDRSharp and it should be changed with your custom images
77-
78-
---
66+
5. Restart SDRSharp. Your custom images will now appear in Discord.
7967

80-
### 📕TODO List
68+
## 📕Roadmap
8169

70+
### Planned Features
8271
- Invite people to get Spy Server Address or connecting via voice chat system to listen and having the ability to change the frequency
8372
- Change Settings Panel to match SDR# theme
8473
- Show "Listening" instead of "Playing"

0 commit comments

Comments
 (0)