Merge branch 'stable' into dev

CODE_OF_CONDUCT.md

@@ -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
+contact@jordongamedev.co.uk.
+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.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing Guidelines
+
+Thank you for considering contributing to HarmonyLinkServer! We welcome your contributions and appreciate the effort to make this project better. To maintain a collaborative and inclusive environment, please follow these guidelines when contributing:
+
+## Opening Issues
+If you encounter any bugs, have feature requests, or want to report an issue, please ensure that it hasn't already been reported by searching through the existing issues. If not, feel free to open a new issue, providing as much detail as possible. Include steps to reproduce the issue, expected behavior, and any relevant error messages.
+
+## Pull Requests
+We gladly accept pull requests! Before submitting a pull request, please follow these steps:
+
+1. Fork the repository and create a new branch for your feature or bug fix.
+2. Make your changes, ensuring that your code adheres to the project's coding conventions.
+3. Write clear and concise commit messages, providing a brief description of the changes made.
+4. Test your changes thoroughly to ensure they work as expected.
+5. Ensure that your branch is up to date with the latest changes from the main repository.
+6. Submit the pull request, providing a detailed description of the changes made and their purpose.
+
+## Coding Standards
+When contributing code, please adhere to the following coding standards:
+
+- Follow the existing code style and formatting used in the project.
+- Write clear, concise, and meaningful comments to improve code readability.
+- Ensure that your code is well-documented, especially for any new or complex functionality added.
+- Run the necessary tests and ensure they pass successfully before submitting any changes.
+
+## Code of Conduct
+We expect all contributors to follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions, both within the project and in the wider community.
+
+## Getting Help
+If you need any assistance, have questions, or need clarification, feel free to reach out by opening an issue or discussion.
+
+We appreciate your contributions and look forward to working with you to improve HarmonyLinkServer!

README.md

@@ -2,11 +2,25 @@
   <img src="Images/HarmonyLinkLogo.png" alt="HarmonyLinkLogo"/>
 </p>
 
-Welcome to the server-side application for the HarmonyLink project. This innovative software is developed with the Rust programming language and is aimed at enhancing the handheld gaming experience. The main function of this application is to run the DLL which is currently closed-source. If this project becomes popular enough, I will reconsider the licensing of the DLL and release it opensource.
+Welcome to the server-side application for the HarmonyLink project. This innovative software is developed with the Rust programming language and is aimed at enhancing the handheld gaming experience.
 
-## The Vision and The Reality
+## Table of Contents
 
-The central goal with HarmonyLink is to provide a comprehensive and interactive gaming experience on handheld devices. This client-side application is a crucial part of this vision.
+- [Shaping the Vision, Living the Reality](#shaping-the-vision,-living-the-reality)
+- [Key Features](#key-features)
+- [Using the Program](#using-the-program)
+  - [Windows Users](#windows-users)
+  - [Steam Deck (Linux) Users](#steam-deck-linux-users)
+- [How It Works](#how-it-works)
+- [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer/wiki/Getting-Started)
+- [HarmonyLink: View](#harmonylink-view)
+- [Showcasing HarmonyLink](#showcasing-harmonylink)
+- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
+- [License](#license)
+
+## Shaping the Vision, Living the Reality
+
+HarmonyLink is on a mission to transform handheld gaming by providing an interactive experience. This server-side application is at the heart of making this vision a reality.
 
 ## Key Features
 
@@ -14,37 +28,83 @@ The central goal with HarmonyLink is to provide a comprehensive and interactive
 2. **Real-Time Metrics**: Games can access real-time data about the handheld device's power usage and docking status through HarmonyLink.
 3. **Cross-Platform Compatibility**: HarmonyLink extends its functionality to Windows games running on Proton/Wine.
 
+## Using HarmonyLinkServer
+
+For users who wish to run the precompiled release version of HarmonyLinkServer, please follow the instructions specific to your platform below.
+
+### Windows Users
+
+1. Navigate to the [latest release](https://github.com/Jordonbc/HarmonyLinkServer/releases/latest) on the project's GitHub page.
+2. Download the `.zip` archive for Windows.
+3. Extract the contents of the `.zip` archive to a directory of your choice.
+4. Open a command prompt in the directory where you extracted the files.
+5. Run the HarmonyLinkServer executable by typing `./harmony_link_server.exe`.
+
+Please note that you'll need to manually start the program each time you want to use it.
+
+### Steam Deck (Linux) Users
+
+1. Navigate to the [latest release](https://github.com/Jordonbc/HarmonyLinkServer/releases/latest) on the project's GitHub page.
+2. Download the `.zip` archive for Linux.
+3. Extract the contents of the `.zip` archive to a directory of your choice.
+
+#### Running in Desktop Mode
+
+To use HarmonyLinkServer in Desktop Mode, follow these steps:
+
+1. Open a terminal in the directory where you extracted the files.
+2. Run the HarmonyLinkServer executable by typing `./harmony_link_server`.
+
+Please note that you'll need to keep the terminal window open while using HarmonyLinkServer in desktop mode.
+
+#### Optional: Setting Up as a Service for Gamemode
+
+For a seamless experience in gamemode, you have the option to set up HarmonyLinkServer as a service on your Steam Deck. Please be aware that this setup process will require a moderate level of technical knowledge.
+
 ## How It Works
 
-HarmonyLink operates using a client-server structure. This server-side application runs the DLL on the host side (native Linux or Windows), and games access the metrics via an API.
+HarmonyLink operates using a client-server structure. This server-side application runs on the host side (native Linux or Windows), and games access the metrics via an API.
 
 Developers and modders can easily implement GET and POST requests from the API, integrating system metrics into games. These metrics can be used to adapt the game's quality settings, providing a more customized gaming experience.
 
-## Getting Started
-
-This project assumes that you already know how to compile and run Rust applications.
-
-1. Clone the repository: `git clone https://github.com/Jordonbc/HarmonyLinkServer.git`
-2. Navigate into the directory: `cd HarmonyLinkServer`
-3. Build the project: `cargo build`
-4. Run the project: `cargo run`
-
-Please note that while the DLL is currently closed-source, we're open to making it open-source if it gains popularity. We're excited to see how the project evolves with community engagement.
-
 ## HarmonyLink: View
 
-To view the API in action, check out [HarmonyLink: View](https://github.com/Jordonbc/HarmonyLinkView). This sister project provides a comprehensive interface to see what the API is doing in real-time.
+To view the API in action, check out [HarmonyLink: View](https://github.com/Jordonbc/HarmonyLinkView). This sister project provides a comprehensive interface to see what data the API is providing.
 
 ## Showcasing HarmonyLink
 
-To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. [https://www.youtube.com/watch?v=Uttf-lcE-Jk](https://www.youtube.com/watch?v=Uttf-lcE-Jk)
+👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode.
 
-## Conclusion
+[![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4)
 
-HarmonyLink is a significant step towards revolutionizing the handheld gaming experience. Whether you're a game developer aiming to optimize your games for handheld devices or a gamer seeking a more personalized handheld gaming experience, HarmonyLink might just be what you've been waiting for.
+## Contributing Guidelines
 
-We welcome your feedback, questions, and suggestions. Feel free to raise an issue or submit a pull request. Happy coding and game on!
+Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for detailed information on how to contribute to HarmonyLinkServer. It includes instructions for bug reports, feature requests, and pull requests.
+
+We appreciate your interest in improving HarmonyLinkServer and look forward to your contributions!
+
+## Frequently Asked Questions (FAQ)
+
+### Q1: What platforms are supported by HarmonyLink?
+
+A: HarmonyLink supports both native Linux and Windows platforms, and extends its functionality to Windows games running on Proton/Wine.
+
+### Q2: How can I get started with HarmonyLink?
+
+A: You can start by cloning the HarmonyLinkServer repository. Detailed instructions are provided on the [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer/wiki/Getting-Started) wiki page.
+
+### Q3: Can HarmonyLink be used with games developed in different game engines?
+
+A: Yes, HarmonyLink is designed to be engine-agnostic and can be used with games developed in different engines. For Unreal Engine, there is a specific [Unreal Engine Plugin](https://github.com/Jordonbc/HarmonyLinkUE) available.
+
+### Q4: Is HarmonyLink only for game developers, or can players also use it?
+
+A: While game developers will find HarmonyLink particularly useful for optimizing their games for handheld devices, players can also benefit from the enhanced gaming experience that HarmonyLink provides.
+
+### Q5: Does HarmonyLink have any impact on the performance of the games?
+
+A: HarmonyLink is designed to be lightweight and efficient, with minimal impact on game performance. The primary purpose of HarmonyLink is to enhance game performance by allowing games to adapt their settings based on real-time device metrics.
 
 ## License
 
-This project is licensed under the GNU General Public License v3.0 or later.
+This project is licensed under the GNU General Public License v3.0 or later. Please do not redistribute HarmonyLinkServer. e.g.: Proving an alternative download link or distributing with a game.