Chocolatey Package: OpenRGB

---

This package is part of a family of packages published for OpenRGB. This repository is for the meta package.

• For the installer package, see chocolatey-package-openrgb.install.
• For the portable package, see chocolatey-package-openrgb.portable.

See the Chocolatey FAQs for more information on meta packages and installer/portable packages.

---

Install

Install Chocolatey, and run the following command to install the latest approved stable version from the Chocolatey Community Repository:

choco install openrgb --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. The nupkg can be installed from the current directory (with dependencies sourced from the Community Repository) as follows:

choco install openrgb --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, clone this repository, and run the following command in the cloned repository:

choco pack

A successful build will create openrgb.x.y.z.nupkg, where x.y.z should be the Nuspec's normalized version value at build time.

Note

As of Chocolatey v2.0.0, version values are normalized to contain a SemVer 2.0.0-compliant patch number (i.e. only 2 segments will no longer be honored). Legacy package versions that did not contain these will be padded with a patch number of 0. Going forward, version will be padded accordingly for behavior consistency between v1 and v2 Chocolatey releases.

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. If it is outdated by more than a few days, please open an issue.

AU expects the parent directory that contains this repository to share a name with the Nuspec (openrgb). Your local repository should therefore be cloned accordingly:

git clone git@github.com:brogers5/chocolatey-package-openrgb.git openrgb

Alternatively, a junction point can be created that points to the local repository (preferably within a repository adopting the AU packages template):

mklink /J openrgb ..\chocolatey-package-openrgb

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:

.\update.ps1 -IncludeStream 'Stable'

.\update.ps1 -IncludeStream 'ReleaseCandidate'

To forcibly create an updated package (regardless of whether a new software version is available), pass the -Force switch:

.\update.ps1 -Force

Before submitting a pull request, please test the package using the latest Chocolatey Testing Environment first.