diff --git a/README.md b/README.md index 12f5b71..f99a893 100644 --- a/README.md +++ b/README.md @@ -19,46 +19,14 @@ This repository contains my own personal set of tools to help running Windows on This project provides the following applications: -- [Fan Control](docs/fan-control.md) - control Fan on Windows -- [Performance Overlay](docs/performance-overlay.md) - see FPS and other stats -- [Power Control](docs/power-control.md) - change TDP or refresh rate -- [Steam Controller](docs/steam-controller.md) - use Steam Deck with Game Pass +- [Fan Control](https://steam-deck-tools.ayufan.dev/fan-control.md) - control Fan on Windows +- [Performance Overlay](https://steam-deck-tools.ayufan.dev/performance-overlay.md) - see FPS and other stats +- [Power Control](https://steam-deck-tools.ayufan.dev/power-control.md) - change TDP or refresh rate +- [Steam Controller](https://steam-deck-tools.ayufan.dev/steam-controller.md) - use Steam Deck with Game Pass ## Install -- Download latest `SteamDeckTools-.zip` from [Latest GitHub Releases](https://github.com/ayufan/steam-deck-tools/releases/latest). -- Unpack to `C:\SteamDeckTools` folder. -- Install bellow dependencies. -- Run each application, and mark `Run On Startup`. - -This project requires those dependencies to be installed in order to function properly: - -- [Microsoft Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe) -- [Rivatuner Statistics Server](https://www.guru3d.com/files-details/rtss-rivatuner-statistics-server-download.html) -- [ViGEmBus](https://github.com/ViGEm/ViGEmBus/releases) - -It is strongly advised that following software is uninstalled or disabled: - -- [SWICD](https://github.com/mKenfenheuer/steam-deck-windows-usermode-driver) -- [GlosSI](https://github.com/Alia5/GlosSI) -- [HidHide](https://github.com/ViGEm/HidHide) - -## Additional informations - -- [Controller Shortcuts](docs/shortcuts.md) - default shortcuts when using [Steam Controller](docs/steam-controller.md). -- [Development](docs/development.md) - how to compile this project. -- [Risks](docs/risks.md) - this project uses kernel manipulation and might result in unstable system. -- The latest development version can be found in [GitHub Releases](https://github.com/ayufan/steam-deck-tools/releases). -- The variant with `SteamDeckTools--debug.zip` enables all experimental features enabled, but might be unstable and buggy. - -## Anti-Cheat and Antivirus software - -Since this project uses direct manipulation of kernel memory via `inpoutx64.dll` -it might trigger Antivirus and Anti-Cheat software. - -If you use at least version `0.5.x` you can disable kernel drivers usage that should -avoid trippping Anti-Cheat detection. Set FAN to `Default` and disable `OSD Kernel Drivers`. -Of course you will miss some metrics due to that. +See all instructions here: [https://steam-deck-tools.ayufan.dev/](https://steam-deck-tools.ayufan.dev/). ## Author diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..697eaff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +.bundle +.jekyll-cache +_site/ +vendor/ +Gemfile.lock diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..d3d4b5e --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +gem 'jekyll', '~> 4.3' + +group :jekyll_plugins do + gem 'jekyll-sitemap' + gem 'jekyll-feed' + gem 'jekyll-seo-tag' + gem 'jekyll-optional-front-matter' + gem 'jekyll-readme-index' + gem 'jekyll-titles-from-headings' + gem 'jekyll-relative-links' + gem 'jekyll-theme-primer' + gem 'jekyll-github-metadata' + gem 'jekyll-default-layout' +end diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6c966b9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,73 @@ +# README + +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 + +**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. + +Buy Me a Coffee at ko-fi.com Donate with PayPal + +## Applications + +This project provides the following applications: + +- [Fan Control](fan-control.md) - control Fan on Windows +- [Performance Overlay](performance-overlay.md) - see FPS and other stats +- [Power Control](power-control.md) - change TDP or refresh rate +- [Steam Controller](steam-controller.md) - use Steam Deck with Game Pass + +## Install + +- Download latest `SteamDeckTools-.zip` from [Latest GitHub Releases](https://github.com/ayufan/steam-deck-tools/releases/latest). +- Unpack to `C:\SteamDeckTools` folder. +- Install bellow dependencies. +- Run each application, and mark `Run On Startup`. + +This project requires those dependencies to be installed in order to function properly: + +- [Microsoft Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe) +- [Rivatuner Statistics Server](https://www.guru3d.com/files-details/rtss-rivatuner-statistics-server-download.html) +- [ViGEmBus](https://github.com/ViGEm/ViGEmBus/releases) + +It is strongly advised that following software is uninstalled or disabled: + +- [SWICD](https://github.com/mKenfenheuer/steam-deck-windows-usermode-driver) +- [GlosSI](https://github.com/Alia5/GlosSI) +- [HidHide](https://github.com/ViGEm/HidHide) + +## Additional informations + +- [Controller Shortcuts](shortcuts.md) - default shortcuts when using [Steam Controller](steam-controller.md). +- [Development](development.md) - how to compile this project. +- [Risks](risks.md) - this project uses kernel manipulation and might result in unstable system. +- The latest development version can be found in [GitHub Releases](https://github.com/ayufan/steam-deck-tools/releases). +- The variant with `SteamDeckTools--debug.zip` enables all experimental features enabled, but might be unstable and buggy. + +## Anti-Cheat and Antivirus software + +Since this project uses direct manipulation of kernel memory via `inpoutx64.dll` +it might trigger Antivirus and Anti-Cheat software. + +If you use at least version `0.5.x` you can disable kernel drivers usage that should +avoid trippping Anti-Cheat detection. Set FAN to `Default` and disable `OSD Kernel Drivers`. +Of course you will miss some metrics due to that. + +## 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)](://creativecommons.org/licenses/by-nc/4.0/). + +Free for personal use. Contact me in other cases (`ayufan@ayufan.eu`). diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..8f2aa4f --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,22 @@ +title: (Windows) Steam Deck Tools +description: >- + Fan, Overlay, Power Control and Steam Controller for Windows. +baseurl: "" +url: https://steam-deck-tools.ayufan.dev # the base hostname & protocol for your site, e.g. http://example.com +twitter_username: ayufanpl +github_username: ayufan +repository: ayufan/steam-deck-tools + +include: + - _redirects + +theme: jekyll-theme-primer +plugins: + #- jekyll-feed + - jekyll-sitemap + - jekyll-seo-tag + - jekyll-optional-front-matter + - jekyll-readme-index + - jekyll-titles-from-headings + - jekyll-relative-links + - jekyll-default-layout diff --git a/docs/_redirects b/docs/_redirects new file mode 100644 index 0000000..2da86c5 --- /dev/null +++ b/docs/_redirects @@ -0,0 +1 @@ +/docs/updates/:update_type.xml /updates/:update_type.xml