steam-deck-tools/README.md

4.8 KiB

ROG Ally X Performance Overlay (Fork)

This repository is a personal fork of Steam Deck Tools, customized for my ROG Ally X setup and workflow.

Scope

This fork is focused on PerformanceOverlay only.

Included projects:

  • PerformanceOverlay
  • CommonHelpers
  • ExternalHelpers

The other original applications are intentionally not part of active development in this fork.

Build

dotnet restore PerformanceOverlay/PerformanceOverlay.csproj
dotnet build PerformanceOverlay/PerformanceOverlay.csproj --configuration Release

CI

GitHub Actions is configured to build only PerformanceOverlay and publish a ZIP artifact.

Install latest GitHub build artifact (PowerShell)

To update an existing install directory with files from the latest successful PerformanceOverlay GitHub Actions build artifact:

powershell -ExecutionPolicy Bypass -File scripts/install_from_github_build.ps1 -DestinationDir "C:\SteamDeckTools"

Useful options:

  • -Repository owner/repo (default: nicklavoie/steam-deck-tools)
  • -Ref <branch> (default: main)
  • -ArtifactNamePattern "PerformanceOverlay-*.zip"
  • -CleanDestination (remove destination contents before copying)
  • -GitHubToken <token> (or set GITHUB_TOKEN) for higher API rate limits

Credits

Based on the original Steam Deck Tools project by Kamil Trzciński.

License

This fork remains under the original project license: Creative Commons Attribution-NonCommercial-ShareAlike (CC-BY-NC-SA).


(Windows) Steam Deck Tools

GitHub release (latest SemVer) GitHub release (latest SemVer including pre-releases) GitHub all releases

This repository contains my own personal set of tools to help running Windows on Steam Deck.

This software is provided on best-effort basis and can break your SteamDeck.

Help this project

Consider donating if you are happy with this project:

Buy Me a Coffee at ko-fi.com Donate with PayPal

Install

See all instructions here: https://steam-deck-tools.ayufan.dev/.

Applications

This project provides the following applications:

Additional informations

Join Us

Join Us for help or chat. We are at Official WindowsOnDeck Discord server.

Anti-Cheat and Antivirus software

READ IF PLAYING ONLINE GAMES AND/OR GAMES THAT HAVE ANTI-CHEAT ENABLED.

Author

Kamil Trzciński, 2022-2024

Steam Deck Tools is not affiliated with Valve, Steam, or any of their partners.

License

Creative Commons Attribution-NonCommercial-ShareAlike (CC-BY-NC-SA).

Free for personal use. Contact me in other cases (ayufan@ayufan.eu).