Git Product home page Git Product logo

open-cue-cli's Introduction

Open CUE CLI Build

Command Line Interface (CLI) to change iCUE profiles from the command line and play multiple profiles at once. This CLI uses the iCUE Game SDK via the Open CUE Service. You can use all your customized iCUE profiles.

Getting Started

Download and start the Open CUE Service. Download the latest release of Open CUE CLI and extract the archive. Call the cli tool open-cue-cli.bat or open-cue-cli from a command prompt with the option --help.

Usage: open-cue-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -p, --port <port>        Port of the Open CUE Service
  -H, --host <host or ip>  Hostname or ip address of the Open CUE Service
  --version                Show the version and exit
  -h, --help               Show this message and exit

Commands:
  sdk
  profile

Examples

Activates the profile Fire

> open-cue-cli profile activate Fire

Lists all profiles

> open-cue-cli profile list

Plays the profile Wave as event for a short time

> open-cue-cli profile trigger Wave

Profiles

All profiles that you want to use with the Open CUE CLI must be in the iCUE GameSdkEffects directory. On Windows this is C:\ProgramData\Corsair\CUE4\GameSdkEffects for iCUE 4. These profiles are just the exported files when you export a profile in iCUE. When export profiles from iCUE only select "Lighting Effects" in the export settings.

Profiles are grouped into directories, which normally belong to games because the SDK was designed for iCUE Game integration. Each subdirectory of GameSdkEffects is a group of profiles and contains a priorities.cfg file.

Use own profiles/effects

The subdirectories of GameSdkEffects normally correspond to games, but you can also create own subdirectories. If you want to add your own profiles/effects, create a new directory in the GameSdkEffects directory called profiles. Create a new text file named priorities.cfg in the profiles directory.

In Windows Administrator permissions are required to create new files in the directory, so you may create the file in another directory and then move it in the profiles directory.

The file must contain all profile names one per line with a unique priority value.

MyProfile=3
Other_Profile=8
Test=245

Profile names MUST only contain normal characters "a-z", "A-Z" and "_". Also don't use language specific characters such as ä and é. You must set the name of the profile before exporting it from iCUE, you can't change it later, because it is stored inside the profile file. The priorities comes into play when you activate two profiles, then the profile with the higher priority is shown on top of the other.

Troubleshooting

See Open CUE Service Troubleshooting

Packaging of this application

This package is provided as zip containing optimized executable runtime image. Just download the zip archive for your platform, extract it where you want and then execute one of the executable scripts from the extracted archive.

You can also build the project yourself: ./gradlew runtimeZip The output can be found in the build directory.

Why not provide native executable

Native executables require curl or other native implementations to do http calls. The linking in kotlin is very complex and dynamic linking is uncommon on Windows. I didn't find a way to statically link curl into to the windows native executable produced by kotlin.

open-cue-cli's People

Contributors

dependabot[bot] avatar legion2 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

open-cue-cli's Issues

Boost the delay between command input and profile actually switching

Hello, first, thanks to your documentation, everything worked fine almost immediatly. Using Swagger UI for open-cue-service switch profile flawlessly and instantly. However, there is a small delay (up to one second) between the console input using open-cue-cli and the profile switching. Is there any way to speed up things ? (it will probably impact performance) Thanks for your help.

Activating or triggering profiles

When activating or triggering profiles, I get the following error:
Sdk Error occurred: ProfilesConfigurationProblem - problem related to profiles and priorities file

priorities.cfg:
darkness=0
blue=1

My profiles (darkness.cueprofile and blue.cueprofile) and priorities.cfg are in C:\ProgramData\Corsair\CUE\GameSdkEffects\profiles

And I do have open-cue-service running.

Corsair LCD for cooler not changing

Profiles are working as it should except for the Corsair LCD ring and screen for the cooler.

not sure if it’s something to do with the icue profile export or if open cue just needs to add support for this.

either way the ring does not light up or the screen doesn’t change.

also how can I switch profiles to another profile without having them all run on top of each other when activating a profile.

I just want to switch profiles not have them run on top of each other at the same time?

cheers

Any way to control cooling?

I got this to work and control lighting
Any way to control cooling? Fans etc.

Both of my profiles have different fan profiles and fan curves etc.

Open cue cli no longer working with newest iCue software v5.0.144

Hello, every time I run open-cue-cli it is immediately shutdown with the latest iCue software installed. The previous iCue version still works, though I did have crashing on the previous iCue version, but at least open-cue-cli could load and stay loaded for the most part. Hoping an update might fix this. Fingers crossed, and thank you.

Edit: Sorry I meant to post this in the open-cue-service space. Also, I realized that the service was only developed for iCue 4x Sorry for wasting your time in that regard. I would only ask then, maybe please make a compatible version for the newest iCue 5x? Thank you for your consideration.

java.lang.NoSuchMethodError exception when running CLI on Windows

When I run the newest version on Windows (open-cue-cli --help), I get the following error message:

Exception in thread "main" java.lang.NoSuchMethodError: 'void kotlin.jvm.internal.PropertyReference1Impl.<init>(java.lang.Class, java.lang.String, java.lang.String, int)'
        at io.github.legion2.open_cue_cli.OpenCueCli.<clinit>(OpenCueCli.kt)
        at io.github.legion2.open_cue_cli.MainKt.createCLI(Main.kt:8)
        at io.github.legion2.open_cue_cli.MainKt.main(Main.kt:25)

Not sure what's wrong as - as I understand it - everything should be packaged in this version. What am I doing wrong?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.