From f7f14193424a1665e4ed32b1bddc143856f8ca20 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Thu, 22 Jun 2023 01:48:08 +0100 Subject: [PATCH 01/18] Removed Closed-source text from Readme (cherry picked from commit 3c984158c907e7f1ff21dc3fa30f3f5a40b1609f) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 45efd9f..595d3d1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ HarmonyLinkLogo

-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 From 593f884ad2a2915b036a749272d3b50b511e2d08 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Thu, 22 Jun 2023 01:54:20 +0100 Subject: [PATCH 02/18] Update Readme.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 595d3d1..3538528 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,6 @@ This project assumes that you already know how to compile and run Rust applicati 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. From 584ee679d0505b2832d5d7596eac871d7288b6b7 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Thu, 22 Jun 2023 01:56:22 +0100 Subject: [PATCH 03/18] Updated readme.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3538528..61b8469 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The central goal with HarmonyLink is to provide a comprehensive and interactive ## 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. From 391e0365a63c31001f273ae9170d70176029ffff Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:31:57 +0100 Subject: [PATCH 04/18] Added Prerequisites section to the Getting Started. Moved the existing content of the Getting Started to the compiling section. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61b8469..0ded948 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,14 @@ HarmonyLink operates using a client-server structure. This server-side applicati 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 +### Prerequisites +Before getting started, make sure you have: -This project assumes that you already know how to compile and run Rust applications. +- A working installation of [Rust](https://www.rust-lang.org). +- Familiarity with Rust syntax and concepts. +- [Git](https://git-scm.com/downloads) installed on your system. +### Compiling 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` From ee152a295900160ccf771416a3cd06eee03d5f0f Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:33:11 +0100 Subject: [PATCH 05/18] Added better text to the HarmonyLink: View section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ded948..39d4da9 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Before getting started, make sure you have: ## 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 From 6aa9db5977546a44123cd793c7075572c66b7946 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:33:37 +0100 Subject: [PATCH 06/18] Added new video to the showcasing section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39d4da9..9742725 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ To view the API in action, check out [HarmonyLink: View](https://github.com/Jord ## 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. [![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) ## Conclusion From bf7132846bfd728a3719e60449d936a0c638abfa Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:34:07 +0100 Subject: [PATCH 07/18] Added FAQ section to the Readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 9742725..4da52a1 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,28 @@ HarmonyLink is a significant step towards revolutionizing the handheld gaming ex We welcome your feedback, questions, and suggestions. Feel free to raise an issue or submit a pull request. Happy coding and game on! +## 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 in the [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer#getting-started) section. + +### 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. From b0b07c7e6fa8a51b123452c1550c86bbf6c108a0 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:36:29 +0100 Subject: [PATCH 08/18] Updated Readme licence notice to not redistribute HarmonyLinkServer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4da52a1..4e4730b 100644 --- a/README.md +++ b/README.md @@ -72,4 +72,4 @@ A: HarmonyLink is designed to be lightweight and efficient, with minimal impact ## 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. From 472b61bb102947a97e73b30f101b12b0b00db6b3 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:37:38 +0100 Subject: [PATCH 09/18] Added Using HarmonyLinkServer section to the Readme --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 4e4730b..4dbd2e5 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,39 @@ 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 on the host side (native Linux or Windows), and games access the metrics via an API. From ec0cb38216453b4ceab500c2824c9e26086cafa0 Mon Sep 17 00:00:00 2001 From: Jordon Brooks <16258926+Jordonbc@users.noreply.github.com> Date: Mon, 26 Jun 2023 19:48:23 +0100 Subject: [PATCH 10/18] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ce8e1ad --- /dev/null +++ b/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. From d359c116d0d9525f93847e9b983e404644d50779 Mon Sep 17 00:00:00 2001 From: Jordon Brooks <16258926+Jordonbc@users.noreply.github.com> Date: Mon, 26 Jun 2023 19:50:05 +0100 Subject: [PATCH 11/18] Create CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3de6c26 --- /dev/null +++ b/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! From a4af492f73a55a400c24be83137b2129b86665a3 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 19:50:41 +0100 Subject: [PATCH 12/18] Removed Conclusion from Readme --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 4dbd2e5..3bb4098 100644 --- a/README.md +++ b/README.md @@ -75,12 +75,6 @@ To view the API in action, check out [HarmonyLink: View](https://github.com/Jord 👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. [![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) -## Conclusion - -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. - -We welcome your feedback, questions, and suggestions. Feel free to raise an issue or submit a pull request. Happy coding and game on! - ## Frequently Asked Questions (FAQ) ### Q1: What platforms are supported by HarmonyLink? From dc8e43ec2ec7f0dcf8002e3802569791a924088b Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 20:08:19 +0100 Subject: [PATCH 13/18] Added Contributing Guidelines to the Readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3bb4098..3c9dd2c 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,12 @@ To view the API in action, check out [HarmonyLink: View](https://github.com/Jord 👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. [![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) +## Contributing Guidelines + +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? From 967b1a4f7c0e384fb0f17dd6a08c6555abe79d64 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 21:10:27 +0100 Subject: [PATCH 14/18] Removed Getting Started section as its now in the Wiki --- README.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/README.md b/README.md index 3c9dd2c..23df39d 100644 --- a/README.md +++ b/README.md @@ -54,18 +54,7 @@ HarmonyLink operates using a client-server structure. This server-side applicati 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 -### Prerequisites -Before getting started, make sure you have: - -- A working installation of [Rust](https://www.rust-lang.org). -- Familiarity with Rust syntax and concepts. -- [Git](https://git-scm.com/downloads) installed on your system. - -### Compiling -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` +For details on getting started please go to [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer/wiki/Getting-Started) ## HarmonyLink: View From d781e40b0dce4dd4a363ea43e78f23d3f219211d Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 21:30:29 +0100 Subject: [PATCH 15/18] Removed the Getting Started as it is now in the wiki --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 23df39d..a1bf555 100644 --- a/README.md +++ b/README.md @@ -53,9 +53,6 @@ HarmonyLink operates using a client-server structure. This server-side applicati 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 -For details on getting started please go to [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer/wiki/Getting-Started) - ## 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 data the API is providing. @@ -78,7 +75,7 @@ A: HarmonyLink supports both native Linux and Windows platforms, and extends its ### Q2: How can I get started with HarmonyLink? -A: You can start by cloning the HarmonyLinkServer repository. Detailed instructions are provided in the [Getting Started](https://github.com/Jordonbc/HarmonyLinkServer#getting-started) section. +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? From 7962257919ecf06dd64de0ac10a1cef0d4977c50 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 21:31:12 +0100 Subject: [PATCH 16/18] Added Table of Contents to the Readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a1bf555..a85ff63 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,23 @@ 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 From cb5155aca34695edebcc9f12295a0c49cb294797 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 21:32:38 +0100 Subject: [PATCH 17/18] Fixed an issue with the Readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a85ff63..a17b172 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,8 @@ To view the API in action, check out [HarmonyLink: View](https://github.com/Jord ## Showcasing HarmonyLink -👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. [![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) +👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. +[![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) ## Contributing Guidelines From b1ba9f6fe80283dd76dfb7b91157cd7e3223a5f6 Mon Sep 17 00:00:00 2001 From: Jordon Brooks Date: Mon, 26 Jun 2023 21:33:34 +0100 Subject: [PATCH 18/18] Fixed Readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a17b172..f54a328 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ To view the API in action, check out [HarmonyLink: View](https://github.com/Jord ## Showcasing HarmonyLink 👇 To help visualize its functionality, we've included a demonstration video that showcases HarmonyLink in action on a Steam Deck in gamemode. + [![HarmonyLink in action](https://img.youtube.com/vi/qU3w_fo4nY4/0.jpg)](https://www.youtube.com/watch?v=qU3w_fo4nY4) ## Contributing Guidelines