jordon/HarmonyLink
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions
Revolutionize handheld gaming with adaptive game settings. Optimize graphics and gameplay experience based on real-time system metrics. Open-source project empowering developers to enhance games on portable devices
2 commits 4 branches 6 tags 4.2 MiB
Find a file
Jordon Brooks 54edd950eb Initial Commit
2023-06-02 22:58:55 +01:00
.vscode Initial Commit 2023-06-02 22:58:55 +01:00
src Initial Commit 2023-06-02 22:58:55 +01:00
.gitignore Initial commit 2023-06-02 22:08:19 +01:00
Cargo.toml Initial Commit 2023-06-02 22:58:55 +01:00
LICENSE Initial commit 2023-06-02 22:08:19 +01:00
README.md Initial Commit 2023-06-02 22:58:55 +01:00

README.md

HarmonyLink: The Handheld Game Link

HarmonyLink is a powerful plugin designed to bridge the gap between your favorite game engines and handheld gaming devices. Initially focusing on the Steam Deck, HarmonyLink aims to provide seamless integration with a variety of handheld devices, enabling games to access critical system metrics and offer a more personalized, immersive gaming experience.

Key Features

  • Device Identification: HarmonyLink allows games to recognize the specific handheld device they are running on.

  • User-Set Power Limits: HarmonyLink provides access to user-defined power limits, allowing games to adapt and optimize performance based on these constraints.

  • Real-Time Metrics: With HarmonyLink, games can access real-time information about the handheld device's power usage and docking status, enabling a level of interaction and responsiveness previously unattainable.

  • Cross-Platform Compatibility: Although initial development focuses on Unreal Engine and the Steam Deck, HarmonyLink is designed with the future in mind. We plan to extend compatibility to other game engines like Unity and more handheld devices.

Getting Started

To compile HarmonyLink for Unreal Engine, follow these steps:

NOTE: This guide assumes that you have a basic understanding of using Unreal Engine and its plugin system.

  1. Clone the repository to your local machine.
  2. Navigate to the directory containing the .uproject file of your Unreal Engine project.
  3. Create a "Plugins" folder if it doesn't already exist.
  4. Copy the "HarmonyLink" folder into the "Plugins" folder.
  5. Open your Unreal Engine project. You'll be prompted to build missing modules.
  6. Click "Yes" to rebuild now.

Get Involved

HarmonyLink is a community-driven project and we welcome contributions of all kinds:

  • Bug Reports: Found a problem? Let us know so we can fix it!
  • Feature Suggestions: Have an idea for improving HarmonyLink? We'd love to hear it.
  • Code Contributions: Want to get your hands dirty? Feel free to make a pull request. For major changes, please open an issue first to discuss what you'd like to change.

Before contributing, please make sure to read our Contributing Guide and Code of Conduct.

Join us as we revolutionize the handheld gaming experience. Whether you're a game developer aiming to optimize your game for handheld devices or a gamer looking forward to more immersive and responsive handheld games, HarmonyLink is the plugin you've been waiting for.