ryzen-controller/README.md

Ryzen controller

I'm looking for maintainers and reviewers, if you know Electron/React and have some spare times, please open an issue or ping @storm1er#0376 or @JamesCJ#2020 on discord.

Thanks to https://github.com/FlyGoat/RyzenAdj and his author, ryzenadj.exe is included (windows only for now).

• What's this?
• Installation
  • Windows
  • Debian like
  • Redhat like
• Troubleshoot, Q&A
• Development
  • Pre-requisite
  • Dev install
  • Building binaries and installers
    • Using Windows
    • Using Linux

Disclaimers & Cautions

• If you intend to use Ryzen Controller in a video/text post online (e.g. YouTube, Reddit) you must credit the Ryzen Controller team by linking to the Ryzen Controller website! We ask this so that viewers/readers can download the software from a trusted source and so the developers get the proper recognition for their work.
• Ryzen Controller Team is not liable for any damages that my occur from using Ryzen Controller or RyzenADJ, Please use at your own risk!
• If you wish to join us developing Ryzen Controller, please join the community discord server and ping either @storm1er#0376 or @JamesCJ#2020.

What's this?

• It's a little Ryzen Master for laptops.
• Works best on 2xxx and 3xxx Ryzen series (4xxx series is experimental)

Installation

Windows

• Go to release page
• Download the latest Ryzen Controller Setup X.X.X.exe
• Enjoy!

Debian like

• Go to RyzenAdj repo.
• Download and build as explained in Build requirements.
• Go to Ryzen Controller's release page
• Download the latest ryzen-controller_X.X.X_ARCH.deb file.
• sudo dpkg -i ryzen-controller_X.X.X_ARCH.deb
• Launch with sudo ryzencontroller
• Set the path to your freshly builded ryzenadj binary into the "settings" tab.
• Enjoy!

Redhat like

• Go to RyzenAdj repo.
• Download and build as explained in Build requirements.
• Go to Ryzen Controller's release page
• Download the latest ryzen-controller-X.X.X.ARCH.rpm file.
• sudo rpm -u ryzen-controller-X.X.X.ARCH.rpm
• Launch with sudo ryzencontroller
• Set the path to your freshly builded ryzenadj binary into the "settings" tab.
• Enjoy!

Troubleshoot, Q&A

I'm getting an error when installing ryzen controller on linux

You may need to install smartmontools & lm-sensors packages to allow Ryzen Controller to work well.

# Install the app
sudo dpkg -i ryzen-controller_x.x.x_amd64.deb
# If you get error about missing dependencies
sudo apt-get -f install
# To ensure correct temperature and others sys-info
sudo apt-get -y smartmontools lm-sensors

Why yarn?

See https://github.com/electron-userland/electron-builder/issues/1147#issuecomment-276284477

Development

THIS PART IS ONLY FOR DEVELOPMENT PURPOSE, IF YOU JUST WANT TO USE RYZEN CONTROLLER, SEE THE INSTALLATION PART.

Pre-requisite

• NodeJS v10.18.0 or newer.
• About building dependencies:
  • No dependencies for windows installer
  • See electron-installer-debian requirements
  • See electron-installer-redhat requirements

Dev install

cd project
yarn install --frozen-lockfile # Please commit any change in yarn.lock/package.json in separated merge request
yarn start # You may want to look at "start:*" scripts in package.json

Building binaries and installers

Using Windows

cd project
yarn docker # may not be needed, depends on your machine
yarn clean # You may want to look at "clean:*" scripts in package.json
yarn dist-pack-win # You may want to look at "dist-pack:*" scripts in package.json

Using Linux

cd project
yarn docker # may not be needed, depends on your machine
yarn clean # You may want to look at "clean:*" scripts in package.json
yarn dist-pack-linux # You may want to look at "dist-pack:*" scripts in package.json