steam-deck-tools/README.md
2022-12-20 18:34:31 +01:00

62 lines
3.3 KiB
Markdown

# (Windows) Steam Deck Tools
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ayufan/steam-deck-tools?label=stable&style=flat-square)](https://github.com/ayufan/steam-deck-tools/releases/latest)
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/ayufan/steam-deck-tools?color=red&include_prereleases&label=beta&style=flat-square)](https://github.com/ayufan/steam-deck-tools/releases)
![GitHub all releases](https://img.shields.io/github/downloads/ayufan/steam-deck-tools/total?style=flat-square)
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.**
<img src="docs/images/power_control.png" height="250"/>
## Help this project
**This project is provided free of charge, but development of it is not free - it takes a lot of effort**:
- Consider donating to keep this project alive.
- Donating also helps to fund new features.
<a href='https://ko-fi.com/ayufan' target='_blank'><img height='35' style='border:0px;height:50px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' alt='Buy Me a Coffee at ko-fi.com' /></a> <a href="https://www.paypal.com/donate/?hosted_button_id=DHNBE2YR9D5Y2" target='_blank'><img height='35' src="https://raw.githubusercontent.com/stefan-niedermann/paypal-donate-button/master/paypal-donate-button.png" alt="Donate with PayPal" style='border:0px;height:55px;'/></a>
## Install
See all instructions here: [https://steam-deck-tools.ayufan.dev/](https://steam-deck-tools.ayufan.dev/).
## Applications
This project provides the following applications:
- [Fan Control](https://steam-deck-tools.ayufan.dev/fan-control) - control Fan on Windows
- [Performance Overlay](https://steam-deck-tools.ayufan.dev/performance-overlay) - see FPS and other stats
- [Power Control](https://steam-deck-tools.ayufan.dev/power-control) - change TDP or refresh rate
- [Steam Controller](https://steam-deck-tools.ayufan.dev/steam-controller) - use Steam Deck with Game Pass
## Additional informations
- [Controller Shortcuts](https://steam-deck-tools.ayufan.dev/shortcuts) - default shortcuts when using [Steam Controller](https://steam-deck-tools.ayufan.dev/steam-controller).
- [Development](https://steam-deck-tools.ayufan.dev/development) - how to compile this project.
- [Risks](https://steam-deck-tools.ayufan.dev/risks) - this project uses kernel manipulation and might result in unstable system.
- [Privacy](https://steam-deck-tools.ayufan.dev/privacy) - this project can connect to remote server to check for auto-updates or track errors
- [Troubleshooting](https://steam-deck-tools.ayufan.dev/troubleshooting) - if you encounter any problems.
## Join Us
Join Us for help or chat. We are at [#windows of Steam Deck Discord](https://discord.com/channels/865611969661632521/867449233261985812).
## Anti-Cheat and Antivirus software
[READ IF PLAYING ONLINE GAMES AND/OR GAMES THAT HAVE ANTI-CHEAT ENABLED](https://steam-deck-tools.ayufan.dev/#anti-cheat-and-antivirus-software).
## Author
Kamil Trzciński, 2022
Steam Deck Tools is not affiliated with Valve, Steam, or any of their partners.
## License
[Creative Commons Attribution-NonCommercial (CC-BY-NC)](https://creativecommons.org/licenses/by-nc/4.0/).
Free for personal use. Contact me in other cases (`ayufan@ayufan.eu`).