diff --git a/Readme.md b/Readme.md index c35cf88..0d7f42f 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,5 @@ # Open CUE CLI [![Build](https://github.com/Legion2/open-cue-cli/workflows/Build/badge.svg)](https://github.com/Legion2/open-cue-cli/actions?query=workflow%3ABuild) -Command Line Interface (CLI) to change iCUE profiles form the command line and play multiple profiles at once. +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 [iCUE Unofficial Game Integration](https://github.com/Zac-McDonald/iCUE-Custom-Game-Integration) server. ## Getting Started @@ -30,7 +30,7 @@ Activates the profile `SDKL_Fire` from the game `Common` and also set the game a open-cue-cli state set -s -g Common SDKL_Fire ``` -Lists all profiles from the current game +Lists all profiles of the current game ``` open-cue-cli profile list ``` @@ -43,26 +43,32 @@ open-cue-cli event set SDKL_Explosion ### Profiles All profiles that you want to use with the Open CUE CLI must be in the iCUE `GameSdkEffects` directory. On Windows this is in the installation directory of iCUE `C:\Program Files (x86)\Corsair\CORSAIR iCUE Software\GameSdkEffects`. -These profiles are like +These profiles are just the exported files from iCUE profiles. +When export profiles from iCUE only select "Lighting Effects" in the export settings. + +Profiles are grouped into games, this is because the SDK was designed for iCUE Game integration. +So each subdirectory of `GameSdkEffects` represent a game and contains all it's profiles and a `priorities.cfg` file. ### Use own profiles/effects -Directories in `GameSdkEffects` correspond to games, but the games must not exist. +The subdirectories of `GameSdkEffects` 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 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 profiles one per line with a unique priority value. +The file must contain all profile names one per line with a unique priority value. ```properties MyProfile1=3 OtherProfile=8 Test=245 ``` -The priority comes into play when you activate two profiles, then the profile with the higher priority is shown on top of the other. +Profile names **SHOULD NOT** contain special characters like `-`, `*`, `.` and spaces. +Underscores (`_`) are allowed in profile names. +The priorities comes into play when you activate two profiles, then the profile with the higher priority is shown on top of the other. ## Packaging of this application This package is provide as zip containing executables and dependencies as jars. -A Java Runtime Environment (JRE) must be installed on to run the application. +A Java Runtime Environment (JRE) must be installed to run the application. Just download the zip archive, extract it where you want and then execute one of the executable scripts from the extracted archive. ### Why not provide native executable