steam-deck-tools/README.md

59 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

2022-12-12 01:05:38 +01:00
# (Windows) Steam Deck Tools
2022-11-12 15:34:33 +01:00
2022-12-13 10:52:27 +01:00
[![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)
2022-11-12 15:34:33 +01:00
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.**
2023-01-12 22:58:55 +01:00
<img src="docs/images/overlay.png" height="400"/>
2022-12-10 02:12:20 +01:00
2022-12-10 02:00:15 +01:00
## Help this project
2022-11-27 20:25:23 +01:00
2023-05-21 19:26:15 +02:00
**Consider donating if you are happy with this project:**
2022-11-12 15:34:33 +01:00
2022-12-10 02:21:20 +01:00
<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>
2022-11-12 15:34:33 +01:00
2022-12-12 12:14:04 +01:00
## Install
See all instructions here: [https://steam-deck-tools.ayufan.dev/](https://steam-deck-tools.ayufan.dev/).
2022-12-10 02:00:15 +01:00
## Applications
2022-11-12 15:47:23 +01:00
2022-12-10 02:21:20 +01:00
This project provides the following applications:
2022-11-12 15:47:23 +01:00
- [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
2022-11-12 15:47:23 +01:00
2022-12-12 12:14:04 +01:00
## Additional informations
2022-11-12 15:47:23 +01:00
- [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.
2022-12-15 10:24:57 +01:00
## Join Us
Join Us for help or chat. We are at [Official WindowsOnDeck](https://discord.gg/uF7kd33u7u) Discord server.
2022-12-15 10:24:57 +01:00
2022-12-20 18:34:31 +01:00
## 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).
2022-11-12 15:34:33 +01:00
## Author
2024-05-30 19:19:03 +02:00
Kamil Trzciński, 2022-2024
2022-11-20 16:50:46 +01:00
2022-11-29 16:21:54 +01:00
Steam Deck Tools is not affiliated with Valve, Steam, or any of their partners.
2022-11-20 16:50:46 +01:00
## License
2023-01-09 20:26:29 +01:00
[Creative Commons Attribution-NonCommercial-ShareAlike (CC-BY-NC-SA)](http://creativecommons.org/licenses/by-nc-sa/4.0/).
2022-11-20 16:50:46 +01:00
Free for personal use. Contact me in other cases (`ayufan@ayufan.eu`).