mirror of
https://github.com/EnderIce2/SDR-RPC.git
synced 2025-05-26 03:04:27 +00:00
Compare commits
4 Commits
v1.3.0.0-p
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
0ba98d0f7d | ||
|
|
a65131280e | ||
|
|
0211e2e633 | ||
|
|
a1bbdfc1a6 |
128
CODE_OF_CONDUCT.md
Normal file
128
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
enderice2@protonmail.com.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
95
CONTRIBUTING.md
Normal file
95
CONTRIBUTING.md
Normal file
@ -0,0 +1,95 @@
|
||||
# Contributing to SDR-RPC
|
||||
|
||||
Thank you for considering contributing to **SDR-RPC**! Your input, feedback, and contributions help make this project better for everyone. Whether you're submitting a bug report, suggesting a new feature, or contributing code, this guide will help you get started.
|
||||
|
||||
---
|
||||
|
||||
## How Can You Contribute?
|
||||
|
||||
### Reporting Bugs
|
||||
If you find a bug, please help us by reporting it. When creating a bug report, provide as much detail as possible to make it easier for us to investigate and resolve the issue.
|
||||
|
||||
#### Steps for Reporting Bugs:
|
||||
1. Check the [issues page](https://github.com/EnderIce2/SDR-RPC/issues) to see if the bug has already been reported.
|
||||
2. If not, create a new issue and include:
|
||||
- A clear and descriptive title.
|
||||
- Steps to reproduce the issue.
|
||||
- Your system configuration (OS version, SDRSharp version, etc.).
|
||||
- Any error logs or screenshots that might help.
|
||||
|
||||
---
|
||||
|
||||
### Suggesting Features or Enhancements
|
||||
Have an idea to improve SDR-RPC? We’d love to hear it!
|
||||
|
||||
#### Steps for Suggesting Features:
|
||||
1. Check the [issues page](https://github.com/EnderIce2/SDR-RPC/issues) to ensure the feature hasn't already been requested.
|
||||
2. Create a new issue and include:
|
||||
- A clear description of the feature or enhancement.
|
||||
- Why this feature would be useful.
|
||||
- Any relevant examples or references.
|
||||
|
||||
---
|
||||
|
||||
### Contributing Code
|
||||
We welcome pull requests for bug fixes, features, or documentation improvements.
|
||||
|
||||
#### Steps for Code Contributions:
|
||||
1. **Fork the Repository**
|
||||
- Navigate to the project repository and click **Fork**.
|
||||
2. **Clone Your Fork**
|
||||
- Clone the repository to your local machine:
|
||||
```bash
|
||||
git clone https://github.com/your-username/SDR-RPC.git
|
||||
```
|
||||
3. **Create a New Branch**
|
||||
- Use a descriptive name for your branch:
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
4. **Write and Test Your Code**
|
||||
- Follow the coding standards used in the project.
|
||||
- Ensure your code works by testing it thoroughly.
|
||||
5. **Commit Your Changes**
|
||||
- Write a clear and concise commit message:
|
||||
```bash
|
||||
git commit -m "Add a clear description of the changes"
|
||||
```
|
||||
6. **Push Your Changes**
|
||||
- Push your branch to your forked repository:
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
7. **Create a Pull Request**
|
||||
- Open a pull request from your branch to the `main` branch of the repository.
|
||||
- Include a detailed description of your changes.
|
||||
|
||||
#### Guidelines:
|
||||
- Ensure your code adheres to the existing coding style.
|
||||
- Document your changes if they impact functionality.
|
||||
- Keep pull requests focused—address one issue or feature per PR.
|
||||
|
||||
---
|
||||
|
||||
### Improving Documentation
|
||||
If you spot errors or outdated information in the documentation, feel free to submit corrections. This includes the `README.md`, `CONTRIBUTING.md`, and in-code comments.
|
||||
|
||||
---
|
||||
|
||||
## Development Environment Setup
|
||||
|
||||
To contribute effectively, set up your environment using the following steps:
|
||||
1. Install [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) or later.
|
||||
2. Install the [.NET Framework 4.6 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer).
|
||||
3. Download the [SDRSharp Plugin SDK](https://airspy.com/?ddownload=5944).
|
||||
4. Clone the repository and open the `SDRSharpPlugin.DiscordRPC.sln` file in Visual Studio.
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please treat others with respect and professionalism.
|
||||
|
||||
---
|
||||
|
||||
Thank you for contributing to SDR-RPC! If you have any questions, feel free to ask on the [issues page](https://github.com/EnderIce2/SDR-RPC/issues).
|
||||
75
README.md
75
README.md
@ -1,43 +1,28 @@
|
||||
|
||||
|
||||
|
||||
[](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)
|
||||
[](https://www.codefactor.io/repository/github/enderice2/sdr-rpc)
|
||||
[](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:
|
||||
[](https://youtu.be/OOnt8ytrDc0 "")
|
||||
|
||||
[](http://www.youtube.com/watch?v=Otn-xSn_ioI "")
|
||||
## 💻Building from Source
|
||||
|
||||
---
|
||||
|
||||
### 🎫Example
|
||||
|
||||
📽Video:
|
||||
|
||||
[](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`.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Go back to General Information and copy Client ID
|
||||
3. Go to **General Information** and copy the **Client ID**.
|
||||
|
||||
|
||||
|
||||
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**.
|
||||
|
||||
|
||||
|
||||
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"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user