{"id":18701990,"url":"https://github.com/legion2/open-cue-service","last_synced_at":"2025-04-12T08:32:39.165Z","repository":{"id":38462647,"uuid":"256592063","full_name":"Legion2/open-cue-service","owner":"Legion2","description":"HTTP REST API service for Open CUE CLI","archived":false,"fork":false,"pushed_at":"2024-08-01T03:31:36.000Z","size":1846,"stargazers_count":39,"open_issues_count":8,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T03:51:14.645Z","etag":null,"topics":["corsair","corsair-cue","icue"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Legion2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Legion2","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"paypal.me/LeonKiefer"}},"created_at":"2020-04-17T19:30:11.000Z","updated_at":"2025-02-22T12:47:28.000Z","dependencies_parsed_at":"2024-01-14T01:49:25.734Z","dependency_job_id":"8917c209-17a6-481d-98ce-fbdfef3dbeee","html_url":"https://github.com/Legion2/open-cue-service","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Legion2%2Fopen-cue-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Legion2%2Fopen-cue-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Legion2%2Fopen-cue-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Legion2%2Fopen-cue-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Legion2","download_url":"https://codeload.github.com/Legion2/open-cue-service/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248540254,"owners_count":21121323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["corsair","corsair-cue","icue"],"created_at":"2024-11-07T11:43:10.146Z","updated_at":"2025-04-12T08:32:37.225Z","avatar_url":"https://github.com/Legion2.png","language":"C#","funding_links":["https://github.com/sponsors/Legion2","paypal.me/LeonKiefer"],"categories":[],"sub_categories":[],"readme":"# Open CUE Service [![latest release](https://img.shields.io/github/v/release/Legion2/open-cue-service)](https://github.com/Legion2/open-cue-service/releases/latest) [![Build](https://github.com/Legion2/open-cue-service/workflows/Build/badge.svg)](https://github.com/Legion2/open-cue-service/actions?query=workflow%3ABuild)\nHTTP REST API service for [Open CUE CLI](https://github.com/Legion2/open-cue-cli).\n\n## Getting Started\nDownload and extract the latest [release](https://github.com/Legion2/open-cue-service/releases).\nWith iCUE 5 the iCUE profiles in the `C:\\ProgramData\\Corsair\\CUE5\\GameSdkEffects\\profiles` directory are used.\nCreate this directory or configure another one, for details on how to setup profiles see [Open CUE CLI documentation](https://github.com/Legion2/open-cue-cli#profiles).\nThen execute the `open-cue-service.exe` to start the service.\nIt runs on [http://localhost:25555](http://localhost:25555) and can be accessed with any Rest/Http client.\nBy default the API is only available on localhost for security reasons, if you want to expose it in your network please setup a HTTP proxy with authentication such as nginx.\n\n## API Documentation\nThe Rest API exposes an OpenAPI Document at `/openapi/v1/openapi.json`.\nThe API definition can be viewed in the interactive Swagger UI which is hosted at `/openapi`.\nJust start the server and open [http://localhost:25555/openapi](http://localhost:25555/openapi).\nYou can also open the [online version of the API documentation](https://legion2.github.io/open-cue-service/) to explore it without running the server.\n\n[![openapi](docs/img/openapi.png)](https://legion2.github.io/open-cue-service/)\n\n## Configuration\nThe profiles directory can be changed, the default is `profiles`.\nChange the property `\"ProfilesDirectoryName\": \"\u003cyour profile directory\u003e\"` in the `appsettings.json`.\n\nThe Auto Sync for automatic reconnect and detection of crashed iCUE must be enable in the configuration.\nFor the Auto Sync feature an additional profile is required, which must be in the selected profile directory.\nThe profile should be empty and should not have any lighting effect.\nThe profile is used by the service to check if iCUE is running and can be controlled.\nChange the property `\"AutoSyncProfileName\": \"\u003cname of empty profile\u003e\"` in the `appsettings.json`.\nWhen using the Auto Sync feature, for some effects the opacity value lower than 100% can cause lighting artifacts.\n\nYou can also configure the Auto Sync Interval, which is the time in seconds between the checks if iCUE is running.\nChange the property `\"AutoSyncInterval\": \u003cinterval in seconds\u003e` in the `appsettings.json`.\n\nTo activate a profile on startup you can set the property `\"StartProfileName\": \"\u003cprofile name\u003e\"` to an existing profile you want to be active on start.\nDefault is an empty string, which means no profile will be activated on startup.\n\n## Troubleshooting\n\n### Sdk Error occurred: InvalidArguments\n\nThis error could indicate the missing or wrong profiles directory.\nMake sure the profiles directory is correctly created according to the [Open CUE CLI documentation](https://github.com/Legion2/open-cue-cli#profiles) and the correct name is configured in the `appsettings.json` (`ProfilesDirectoryName` property).\n\n### Sdk Error occurred: ProfilesConfigurationProblem\n\nWhen you get this error, make sure you have created the `priorities.cfg` file with all the entries correctly.\nMake sure you only use allows character in the name of the profiles.\nReexport the profiles which the correct name, do not rename the profiles after you have exported them.\nRestart iCUE and Open CUE Service after you have changed any file.\n\n## License\nThis project is distributed under [Apache License, Version 2.0](LICENSE).\n\nThe software iCUE and the file CgSDK.x64_2015.dll are supplied by Corsair Components, Inc. and distributed under different terms.\nFor more information, contact Corsair Components, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flegion2%2Fopen-cue-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flegion2%2Fopen-cue-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flegion2%2Fopen-cue-service/lists"}