enderice2/SDR-RPC
1
0
Fork 0
mirror of https://github.com/EnderIce2/SDR-RPC.git synced 2025-05-25 23:34:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Related to #14
This commit is contained in:
EnderIce2 2024-11-27 02:52:48 +02:00 committed by GitHub
parent 139af9bdcf
commit a1bbdfc1a6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -1,43 +1,28 @@
![GitHub](https://img.shields.io/github/license/EnderIce2/SDR-RPC) ![GitHub](https://img.shields.io/github/license/EnderIce2/SDR-RPC)
![GitHub All Releases](https://img.shields.io/github/downloads/EnderIce2/SDR-RPC/total) ![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) ![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
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 ## ✨Features
- 🎛Enable / Disable - ✏Displays **frequency, playback state, and RDS information**
- ✏Showing frequency, play state and RDS almost in realtime - 🔌Optimized with **asynchronous code** for smoother performance
- 🔌Most of the code is made asynchronous - 📖**Logging** to help troubleshoot issues
- 📖Logging for troubleshooting problems - 🔨**Simple installation** process
- 🔨Easy to install
--- ## 🎁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
--- ### Prerequisites
Before you start, ensure you have the following:
### 🎫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:
- [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) - [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) - [.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) - [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.PanView.dll
- SDRSharp.Radio.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) ![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" 2. Build the solution in Visual Studio.
4. Build it and move files to SDR# location (if the compile fails try copying Reference files into /bin/Debug or /bin/Release folder) - 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 1. Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
2. Name it "SDRSharp" or something similar - 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) ![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) ![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.
--- ## 📕Roadmap
### 📕TODO List
### 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 - 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 - Change Settings Panel to match SDR# theme
- Show "Listening" instead of "Playing" - Show "Listening" instead of "Playing"