README.md

HyperPlay

Index

• HyperPlay
  • Index
  • Supported Operating Systems
  • Installation
    • Linux
      • Debian, Ubuntu and Derivatives
      • Other Distributions (TAR.XZ)
    • Windows
    • macOS
  • Contributing
  • Credits

Supported Operating Systems

• Windows 8+ (might work on Win7 if you have the latest PowerShell but we do not give support for it)
• Linux:
  • Ubuntu 20.04LTS or newer
  • Fedora 33 or newer
  • Arch Linux (Manjaro and Garuda as well)
  • HyperPlay will still work on most distros but we do not give official support for them. So do not open Issues here in these cases, instead, open a Discussion or try our Discord.
• SteamOS (downloading using Discover only)
• macOS 10.15 or higher

Installation

Linux

Debian, Ubuntu and Derivatives

Download the hyperplay.x.x.x_amd64.deb from the Releases section

sudo dpkg -i hyperplay.x.x.x_amd64.deb

Other Distributions (TAR.XZ)

Since these two distribution formats don't have a form of dependency management, make sure the curl command is available. You might run into weird issues if it's not.

For the tar.xz file, you need first to extract it somewhere, enter the folder and run:

chmod +x hyperplay

To run it use:

./hyperplay

Windows

Download HyperPlay_Setup.x.x.x.exe or the Portable HyperPlay-x.x.x.exe file and run it. It will install it to the start menu and desktop, use those to run it.

macOS

Download HyperPlay-x.x.x.dmg and move the HyperPlay App to the Applications folder.

Screenshots

Contributing

Read our Contribution License Agreement.

Local Development

This projects uses optional NPM packages.

For internal developers, use:

yarn setup
yarn start

For external developers, use:

yarn setupWithoutOptional
yarn start

M1/M2 Mac

If you are using an M1 or M2 Mac and receive the following error message:

Error: Cannot find module @rollup/rollup-darwin-arm64. npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). Please try `npm i` again after removing both package-lock.json and node_modules directory.

Please try the following

rm -f yarn.lock
rm -rf node_modules
yarn cache clean
yarn setupWithoutOptional
yarn start

Lavamoat

Please note that at times, the console may alert you to run yarn allow-scripts auto. This is from @lavamoat/allow-scripts and is due to a dependency adding a new preinstall or postinstall script. After running yarn allow-scripts auto and updating the package.json to enable or disable the script, please run yarn setup or yarn setupWithoutOptional again.

Credits

Those Awesome Guys: Gamepad prompts images

• URL: https://thoseawesomeguys.com/prompts/