ryzen-controller/README.md
James Craddock-Jones 4f16371756 fix: read me file
2020-08-26 00:08:15 +00:00

4.2 KiB

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 on discord.

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

Disclaimer

  • if you intend to use Ryzen Controller in a video posted online e.g. YouTube, please credit the Ryzen Controller team and post a link to the Ryzen Controller website where the users can download the software!!

What's this?

  • It's a little Ryzen Master for laptops.
  • Works best on 2xxx Ryzen series (3xxx 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!

Caution!

  • Ryzen Controller Team is not liable for any damages that my occur from using Ryzen Controller or RyzenADJ, Please use at your own risk!

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

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