|
1 | 1 | 
|
2 | 2 | 
|
3 | 3 | 
|
4 |
| -[](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 |
| -[](https://www.codefactor.io/repository/github/enderice2/sdr-rpc) |
6 |
| -[](https://twitter.com/intent/follow?screen_name=enderice22) |
7 | 4 | # SDR-RPC
|
8 | 5 |
|
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. |
10 | 7 |
|
11 | 8 | ---
|
12 | 9 |
|
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 |
19 | 15 |
|
20 |
| ---- |
21 |
| - |
22 |
| -### 🎁How to install |
| 16 | +## 🎁How to install + Demo |
23 | 17 |
|
24 |
| -📽Video: |
| 18 | +📽**Watch the video:** |
25 | 19 |
|
26 |
| -[](http://www.youtube.com/watch?v=Otn-xSn_ioI "") |
27 |
| - |
28 |
| ---- |
| 20 | +[](https://youtu.be/OOnt8ytrDc0 "") |
29 | 21 |
|
30 |
| -### 🎫Example |
| 22 | +## 💻Building from Source |
31 | 23 |
|
32 |
| -📽Video: |
33 |
| - |
34 |
| -[](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: |
41 | 26 | - [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
|
42 | 27 | - [.NET 4.6](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer)
|
43 | 28 | - [SDRSharp Plugin SDK](https://airspy.com/?ddownload=5944)
|
44 | 29 | - SDRSharp.Common.dll
|
45 | 30 | - SDRSharp.PanView.dll
|
46 | 31 | - SDRSharp.Radio.dll
|
47 | 32 |
|
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`. |
49 | 38 |
|
50 | 39 | 
|
51 | 40 |
|
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. |
54 | 43 |
|
55 |
| ---- |
| 44 | +3. Copy the compiled files to the SDR# installation directory. |
56 | 45 |
|
57 |
| -### 👀Setting your custom images on RPC |
| 46 | +## 👀Customizing RPC Images |
58 | 47 |
|
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. |
61 | 50 |
|
62 |
| - |
| 51 | + |
63 | 52 |
|
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. |
65 | 55 |
|
66 |
| - |
| 56 | + |
67 | 57 |
|
68 |
| -4. Go back to General Information and copy Client ID |
| 58 | +3. Go to **General Information** and copy the **Client ID**. |
69 | 59 |
|
70 | 60 | 
|
71 | 61 |
|
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**. |
73 | 63 |
|
74 | 64 | 
|
75 | 65 |
|
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. |
79 | 67 |
|
80 |
| -### 📕TODO List |
| 68 | +## 📕Roadmap |
81 | 69 |
|
| 70 | +### Planned Features |
82 | 71 | - Invite people to get Spy Server Address or connecting via voice chat system to listen and having the ability to change the frequency
|
83 | 72 | - Change Settings Panel to match SDR# theme
|
84 | 73 | - Show "Listening" instead of "Playing"
|
0 commit comments