Initial release

Author: brogers5

.gitignore

@@ -0,0 +1,3 @@
+/*.nupkg
+/tools/OpenRGB_*_Windows_64_*.msi
+/OpenRGB-release_*.zip

DESCRIPTION.md

@@ -0,0 +1,33 @@
+## OpenRGB
+
+One of the biggest complaints about RGB is the software ecosystem surrounding it. Every manufacturer has their own app, their own brand, their own style. If you want to mix and match devices, you end up with a ton of conflicting, functionally identical apps competing for your background resources. On top of that, these apps are proprietary and Windows-only. Some even require online accounts. What if there was a way to control all of your RGB devices from a single app, on both Windows and Linux, without any nonsense? That is what OpenRGB sets out to achieve. One app to rule them all.
+
+![OpenRGB Screenshot](https://cdn.jsdelivr.net/gh/brogers5/chocolatey-package-openrgb.install@4559dfe2a59c5e2a7df1cb69957ab8e5125d4401/Screenshot.png)
+
+### Features
+
+* Set colors and select effect modes for a wide variety of RGB hardware
+* Save and load profiles
+* Control lighting from third party software using the OpenRGB SDK
+* Command line interface
+* Connect multiple instances of OpenRGB to synchronize lighting across multiple PCs
+* Can operate standalone or in a client/headless server configuration
+* View device information
+* No official/manufacturer software required
+* Graphical view of device LEDs makes creating custom patterns easy
+
+## Package Parameters
+
+* `/NoShim` - Opt out of creating a shim, and removes any existing shim.
+
+## Package Notes
+
+This package may create a [shim](https://docs.chocolatey.org/en-us/features/shim) for `OpenRGB.exe` to facilitate easier access to its command-line interface. However, `shimgen` will create a GUI shim, which will not wait for the underlying process to exit by default. This may cause issues with displaying console output when using the command-line interface. Users requiring this functionality should pass the `--shimgen-waitforexit` switch to ensure the shim behaves correctly.
+
+---
+
+For future upgrade operations, consider opting into Chocolatey's `useRememberedArgumentsForUpgrades` feature to avoid having to pass the same arguments with each upgrade:
+
+```shell
+choco feature enable --name="'useRememberedArgumentsForUpgrades'"
+```

LICENSE

@@ -1,133 +1,73 @@
-## Summary
-How do I create packages? See https://docs.chocolatey.org/en-us/create/create-packages
-
-If you are submitting packages to the community feed (https://community.chocolatey.org)
-always try to ensure you have read, understood and adhere to the create
-packages wiki link above.
-
-## Automatic Packaging Updates?
-Consider making this package an automatic package, for the best
-maintainability over time. Read up at https://docs.chocolatey.org/en-us/create/automatic-packages
-
-## Shim Generation
-Any executables you include in the package or download (but don't call
-install against using the built-in functions) will be automatically shimmed.
-
-This means those executables will automatically be included on the path.
-Shim generation runs whether the package is self-contained or uses automation
-scripts.
-
-By default, these are considered console applications.
-
-If the application is a GUI, you should create an empty file next to the exe
-named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'.
-See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui
-
-If you want to ignore the executable, create an empty file next to the exe
-named 'name.exe.ignore' e.g. 'bob.exe' would need a file named
-'bob.exe.ignore'.
-See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims
-
-## Self-Contained?
-If you have a self-contained package, you can remove the automation scripts
-entirely and just include the executables, they will automatically get shimmed,
-which puts them on the path. Ensure you have the legal right to distribute
-the application though. See https://docs.chocolatey.org/en-us/information/legal.
-
-You should read up on the Shim Generation section to familiarize yourself
-on what to do with GUI applications and/or ignoring shims.
-
-## Automation Scripts
-You have a powerful use of Chocolatey, as you are using PowerShell. So you
-can do just about anything you need. Choco has some very handy built-in
-functions that you can use, these are sometimes called the helpers.
-
-### Built-In Functions
-https://docs.chocolatey.org/en-us/create/functions
-
-A note about a couple:
-* Get-ToolsLocation - used to get you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://docs.chocolatey.org/en-us/create/functions/get-toolslocation
-* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://docs.chocolatey.org/en-us/create/functions/install-binfile
-* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile
-
-### Getting package specific information
-Use the package parameters pattern - see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument
-
-### Need to mount an ISO?
-https://docs.chocolatey.org/en-us/guides/create/mount-an-iso-in-chocolatey-package
-
-### Environment Variables
-Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):
-
- * TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder
- * ChocolateyInstall - Top level folder where Chocolatey is installed
- * ChocolateyPackageName - The name of the package, equivalent to the `<id />` field in the nuspec
- * ChocolateyPackageTitle - The title of the package, equivalent to the `<title />` field in the nuspec
- * ChocolateyPackageVersion - The normalized version of the package, equivalent to a normalized edition of the `<version />` field in the nuspec
- * ChocolateyPackageFolder - The top level location of the package folder  - the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`.
-
-#### Advanced Environment Variables
-The following are more advanced settings:
-
- * ChocolateyPackageParameters - Parameters to use with packaging, not the same as install arguments (which are passed directly to the native installer). Based on `--package-parameters`.
- * CHOCOLATEY_VERSION - The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. Otherwise take a dependency on the specific version you need.
- * ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. Automatically handled in built in Choco functions.
- * OS_PLATFORM - Like Windows, macOS, Linux.
- * OS_VERSION - The version of OS, like 10.0 something something for Windows.
- * OS_NAME - The reported name of the OS.
- * USER_NAME = The user name
- * USER_DOMAIN = The user domain name (could also be local computer name)
- * IS_PROCESSELEVATED = Is the process elevated?
- * IS_SYSTEM = Is the user the system account?
- * IS_REMOTEDESKTOP = Is the user in a terminal services session?
- * ChocolateyToolsLocation - formerly 'ChocolateyBinRoot' ('ChocolateyBinRoot' will be removed with Chocolatey v2.0.0), this is where tools being installed outside of Chocolatey packaging will go.
-
-#### Set By Options and Configuration
-Some environment variables are set based on options that are passed, configuration and/or features that are turned on:
-
- * ChocolateyEnvironmentDebug - Was `--debug` passed? If using the built-in PowerShell host, this is always true (but only logs debug messages to console if `--debug` was passed)
- * ChocolateyEnvironmentVerbose - Was `--verbose` passed? If using the built-in PowerShell host, this is always true (but only logs verbose messages to console if `--verbose` was passed).
- * ChocolateyExitOnRebootDetected - Are we exiting on a detected reboot? Set by ` --exit-when-reboot-detected`  or the feature `exitOnRebootDetected`
- * ChocolateyForce - Was `--force` passed?
- * ChocolateyForceX86 - Was `-x86` passed?
- * ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds`
- * ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds`
- * ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost`
-
-#### Business Edition Variables
-
- * ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere.
- * ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-sensitive` that are not logged anywhere.
- * ChocolateyLicensedVersion - What version is the licensed edition on?
- * ChocolateyLicenseType - What edition / type of the licensed edition is installed?
- * USER_CONTEXT - The original user context - different when self-service is used (Licensed)
-
-#### Experimental Environment Variables
-The following are experimental or use not recommended:
-
- * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under
- * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different - based on git describe
- * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated.
- * IS_REMOTE = Is the user in a remote session?
-
-#### Not Useful Or Anti-Pattern If Used
-
- * ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed.
- * ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed.
- * ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off?
- * ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on?
- * ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on?
- * ChocolateyChecksum32 - Was `--download-checksum` passed?
- * ChocolateyChecksumType32 - Was `--download-checksum-type` passed?
- * ChocolateyChecksum64 - Was `--download-checksum-x64` passed?
- * ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed?
- * ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode`
- * ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging.
- * ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy`
- * ChocolateyDownloadCache - Use available download cache? Set by `--skip-download-cache`, `--use-download-cache`, or feature `downloadCache`
- * ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList`
- * ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal`
- * http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set.
- * https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set.
- * no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set.
+<!--markdownlint-disable-next-line MD033 MD045 -->
+# <img src="https://cdn.jsdelivr.net/gh/brogers5/chocolatey-package-openrgb.install@4559dfe2a59c5e2a7df1cb69957ab8e5125d4401/openrgb.install.png" width="48" height="48" alt="OpenRGB (Install) icon"/> Chocolatey Package: [OpenRGB (Install)](https://community.chocolatey.org/packages/openrgb.install)
 
+[![Latest package version shield](https://img.shields.io/chocolatey/v/openrgb.install.svg?include_prereleases)](https://community.chocolatey.org/packages/openrgb.install)
+[![Total package download count shield](https://img.shields.io/chocolatey/dt/openrgb.install.svg)](https://community.chocolatey.org/packages/openrgb.install)
+
+---
+
+This package is part of a family of packages published for OpenRGB. This repository is for the installer package.
+
+* For the meta package, see [chocolatey-package-openrgb](https://github.com/brogers5/chocolatey-package-openrgb).
+* For the portable package, see [chocolatey-package-openrgb.portable](https://github.com/brogers5/chocolatey-package-openrgb.portable).
+
+See the [Chocolatey FAQs](https://docs.chocolatey.org/en-us/faqs) for more information on [meta packages](https://docs.chocolatey.org/en-us/faqs/#what-is-the-difference-between-packages-no-suffix-as-compared-to-install-portable) and [installer/portable packages](https://docs.chocolatey.org/en-us/faqs#what-distinction-does-chocolatey-make-between-an-installable-and-a-portable-application).
+
+---
+
+## Install
+
+[Install Chocolatey](https://chocolatey.org/install), and run the following command to install the latest approved stable version from the Chocolatey Community Repository:
+
+```shell
+choco install openrgb.install --source="'https://community.chocolatey.org/api/v2'"
+```
+
+Alternatively, the packages as published on the Chocolatey Community Repository will also be mirrored on this repository's [Releases page](https://github.com/brogers5/chocolatey-package-openrgb.install/releases). The `nupkg` can be installed from the current directory (with dependencies sourced from the Community Repository) as follows:
+
+```shell
+choco install openrgb.install --source="'.;https://community.chocolatey.org/api/v2/'"
+```
+
+This package also supports the project's Release Candidate builds. Opt into these with the `--prerelease` switch.
+
+## Build
+
+[Install Chocolatey](https://chocolatey.org/install), and the [Chocolatey Automatic Package Updater Module](https://github.com/majkinetor/au), then clone this repository.
+
+Once cloned, simply run `build.ps1`. The MSI is intentionally untracked to avoid bloating the repository, so the script will download the OpenRGB installer MSI from the official distribution point, then packs everything together.
+
+A successful build will create `openrgb.install.x.y.z.nupkg`, where `x.y.z` should be the Nuspec's normalized `version` value at build time.
+
+>[!Note]
+>Chocolatey package builds are non-deterministic. Consequently, an independently built package's checksum will not match that of the officially published package.
+
+## Update
+
+This package should be automatically updated by the [Chocolatey Automatic Package Updater Module](https://github.com/majkinetor/au). If it is outdated by more than a few days, please [open an issue](https://github.com/brogers5/chocolatey-package-openrgb.install/issues).
+
+AU expects the parent directory that contains this repository to share a name with the Nuspec (`openrgb.install`). Your local repository should therefore be cloned accordingly:
+
+```shell
+git clone git@github.com:brogers5/chocolatey-package-openrgb.install.git openrgb.install
+```
+
+Alternatively, a junction point can be created that points to the local repository (preferably within a repository adopting the [AU packages template](https://github.com/majkinetor/au-packages-template)):
+
+```shell
+mklink /J openrgb.install ..\chocolatey-package-openrgb.install
+```
+
+Once created, simply run `update.ps1` from within the created directory/junction point. Assuming all goes well, all relevant files should change to reflect the latest version available. This will also build a new package version using the modified files.
+
+To limit the scope of update checks to a specific update channel, pass the `-IncludeStream` parameter with the desired Stream name:
+
+```powershell
+.\update.ps1 -IncludeStream 'Stable'
+```
+
+```powershell
+.\update.ps1 -IncludeStream 'ReleaseCandidate'
+```
+
+Before submitting a pull request, please [test the package](https://docs.chocolatey.org/en-us/community-repository/moderation/package-verifier#steps-for-each-package) using the latest [Chocolatey Testing Environment](https://github.com/chocolatey-community/chocolatey-test-environment) first.