Skip to content
Jordon Brooks edited this page Jun 26, 2023 · 3 revisions

Welcome to the HarmonyLinkServer Wiki!

This wiki provides detailed documentation for HarmonyLinkServer, an API server for enhancing the handheld gaming experience.

Introduction

HarmonyLinkServer is a powerful API server developed with the Rust programming language. It aims to enhance the gaming experience on handheld devices by providing real-time metrics and cross-platform compatibility. This server-side application is a crucial component of the HarmonyLink project, enabling games to access device-specific information and adapt their settings accordingly.

Documentation

To get started with HarmonyLinkServer, you can refer to the following documentation:

  • Endpoints: This page provides a detailed overview of the API endpoints available in HarmonyLinkServer, including their URLs, methods, and response formats. It is a comprehensive resource for understanding how to interact with the server and retrieve device metrics.

  • Getting Started: This page provides step-by-step instructions on how to set up and run HarmonyLinkServer on different platforms. It covers prerequisites, compilation, and execution of the server application.

  • HarmonyLink: View: This sister project offers a user-friendly interface to visualize the data provided by the HarmonyLinkServer API. It allows you to explore and analyze real-time device metrics, providing insights into the performance of your handheld gaming experience.

Clone this wiki locally