-# ATTENTION: GloSC is currently being rewritten, and renamed to GlosSI ([Glo]bal ([s]ystemwide) [S]team [I]nput)
+GlosSI formerly knows as GloSC (Global Steam Controller), is a tool that allows one to use Steam-Input controller rebinding at a system-level alongside a system wide (borderless window) Steam overlay
-No ETA when it's done
-No support until then.
+The primary use case of GlosSI is to use SteamInput (required for SteamController / SteamDeck-buttons) with incompatible Games such as Windows-Store titles or Emulators.
-**Looking for contributors!**
-As the past has shown, I have way to less time on hand too maintain such a project.
-Reach out via Discord/E-Mail (But get to the point right away, please, I get way too much spam)
-
-See: [BUILDING.md](./docs/BUILDING.md),[CONTRIBUTING.md](./CONTRIBUTING.md)
-
-Snapshot builds can always be found [-> here <-](https://1-3-3-7.dev/u/glossisnapshot)
-
-# GlosSI
-
-GlosSI or [Glo]bal ([s]ystemwide) [S]team [I]nput, formerly knows as GloSC (Global Steam Controller), is a tool that allows one to use Steam-Input controller rebinding at a system-level alongside a system wide (borderless window) Steam overlay
-All complete with **per application bindings and working rumble emulation.**
GlosSI can, but isn't required to, launch any of your favorite games or applications and directly add them to Steam, be it Win32 or Windows Store (UWP)!
It is **the tool** to enjoy any game that has trouble with Steam and/or *add extra functionality* to your Steam-Input needs
-*Windows Store*, *Reshade / SweetFX*, *Origin*, *Uplay*, *Emulators* and *more* with **no hassle**âĸ
-
---
## How does it work? / What does it do?
-GlosSI creates and adds a (or multiple) non-Steam shortcuts to Steam. When one of those is launched, a transparent, borderless window appears in which you can use the Steam-overlay. You also get access to touch- and radial-menus and other functionality normally only present in Games
+GlosSI provides a target application that can be added as a "Non-Steam Game" to Steam.
+When launched, it redirects all configured controller inputs to a virtual system-level XBox360 controller.
-In addition to that, Gamecontroller-inputs are redirected to the whole operating system, so that they will work with any game or application
-Real Gamecontrollers are hidden from other applications, so that they can't interfere with your game.
+Additionally, it provides the Steam Overlay in an (always on top) transparent window.
-This brings full Steam-Input functionality to the desktop and any other application Steam-Input might not have worked before
+As a result, this brings full Steam-Input functionality to the desktop and any other application Steam-Input might not have worked before.
Games do not need to be launched using GlosSI.
-If the "Start Application" option does not work, launch any GlosSI-Shortcut from Steam, followed by a game or application.
+However, to ease managing multiple GlosSI shortcuts, there is also a GlosSI-Config application included.
+It allows one to create individual GlosSITarget configurations which can launch games for you, and easily add or remove them from Steam.
-## What this is not
+## What GlosSI is not
+
+
- a replacement for Steams controller configuration tool.
-- a Steam remote play / steam game streaming solution. (That being said, it **can** work, but is not guaranteed to.)
-- Old versions (GloSC, Global [S]team[C]ontroller) where never designed to be used with anything other than said controller, GlosSI can be used with any controller.
+- a Steam remote play / steam game streaming solution. (That being said, it **can** work, but is not guaranteed to.)
+ The experience when doing this is most likeley miserable; Thus there is **no support for this use case**.
+- Old versions (GloSC, Global [S]team[C]ontroller) were never designed to be used with anything other than said controller, GlosSI can be used with any controller.
+
----
+## Help and Support
-Join the GlosSI discord here: [https://discord.gg/T9b4D5y](https://discord.gg/T9b4D5y)
+If you're looking for a tutorial on how to use GlosSI check out the [usage section](https://glossi.flatspot.pictures/#usage) on the [GlosSI website](https://glossi.flatspot.pictures/) or check the [usage.md document](./docs/Usage.md)
---
-## GlosSI consists of
+**Get in touch on Discord!**
+Lots of kind and helpful people can be found there, happy to have a quick chat or answer support-requests
+[![Discord](https://img.shields.io/discord/368823110817808384.svg)](https://discord.gg/T9b4D5y)
-- The "GlosSITarget" which does most of the magic - Showing the overlay to the user as well as talking to the ViGEm-driver for system wide Controller emulation
-- A config application ("GlosSIConfig") handling shortcut ("GlosSITarget") creation and their addition to Steam.
-
----
+## Other
Like my stuff? Hit me up [on twitter](https://twitter.com/Flatspotpics) or consider donating to my [PayPal](https://www.paypal.me/Flatspotpics)
-GloSC got mentioned from Valve in the [Steam client beta change log on the 9. of January](https://twitter.com/flatspotpics/status/818697837055770624)
+GloSC got mentioned from Valve in the [Steam client beta change log on the 9. of January 2017](https://twitter.com/flatspotpics/status/818697837055770624)
GloSC/GlosSI is not affiliated with Valve, Steam, or any of their partners.
---
-GlosSI is built using [Qt 6.2](https://www.qt.io/) and a fork of [SFML](http://www.sfml-dev.org/) for drawing the overlay
+GlosSI is built using [Qt 6.X](https://www.qt.io/) and a fork of [SFML](http://www.sfml-dev.org/) for drawing the overlay
The system wide Xbox-Controller works via [ViGEm](https://vigem.org/projects/ViGEm/)
Device Hiding via [HidHide](https://vigem.org/projects/HidHide/)
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index 5033428..0000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,4 +0,0 @@
-_site/
-.jekyll-cache/
-.sass-cache/
-Gemfile.lock
\ No newline at end of file
diff --git a/docs/.ruby-version b/docs/.ruby-version
deleted file mode 100644
index e6b7b62..0000000
--- a/docs/.ruby-version
+++ /dev/null
@@ -1 +0,0 @@
-2.7
\ No newline at end of file
diff --git a/docs/BUILDING.md b/docs/BUILDING.md
index a0d74da..6abb432 100644
--- a/docs/BUILDING.md
+++ b/docs/BUILDING.md
@@ -1,35 +1,40 @@
----
----
-
# Building GlosSI
## Windows
Requirements:
+- git
- Visual Studio 2022 (Community edition is fine)
-- Qt 6.2.X (GlosSIConfig only)
-- Qt Visual Studio addin (GlosSIConfig only)
+- [Qt 6.X](https://www.qt.io/download-qt-installer) (GlosSIConfig only)
+- [Qt Visual Studio addin](https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools2022) (GlosSIConfig only)
+
+In a "Developer Powershell for VS 2022" run:
```powershell
+git submodule init
+git submodule update --recursive
+
.\prebuild.ps1
# Open GlosSI.sln and hit build!
Invoke-Item GlosSI.sln
```
+(Note: It can be the case that the first build fails as there are versioning files created when building. Just hit build again and you should be good to go!)
+
In addition to the above, you will need to install the required drivers:
-`ViGEmBusSetup_x64.msi` and `HidHideMSI.msi`
-Both of which can be downloed from [ViGEm's website](https://vigem.org/Downloads/) or by use of the `download_release_deps.ps1` script.
+`ViGEmBusSetup_x64.exe` and `HidHideMSI.exe`
+Both of these can be downloaded from [ViGEm's website](https://vigem.org/Downloads/) or by use of the `download_release_deps.ps1` script.
+
+---
## Linux
Linux support is currently not really implemented.
+No guarantees that the build will even work. (It's probably broken)
That said, very limited linux support is planned for the future.
No Guarantees that the build works out!
-
-Building should be as easy as:
-
**GlosSITarget:**
```shell
diff --git a/docs/Gemfile b/docs/Gemfile
deleted file mode 100644
index d2851ce..0000000
--- a/docs/Gemfile
+++ /dev/null
@@ -1,2 +0,0 @@
-source "https://rubygems.org"
-gem "github-pages", group: :jekyll_plugins
\ No newline at end of file
diff --git a/docs/Overlay.md b/docs/Overlay.md
deleted file mode 100644
index 919a150..0000000
--- a/docs/Overlay.md
+++ /dev/null
@@ -1,16 +0,0 @@
----
----
-
-# GlosSI Overlay
-
-GlosSI provides it's own overlay in addition to that of Steam.
-
-Simply **double press** your assigned Steam overlay key(s) or the Steam/Guide button to bring it up.
-From here you can take a peek at the log and change various settings.
-
-![GlosSI overlay screenshot](./glossi_overlay.png)
-
-In addition to Keyboard/Mouse, the overlay is also compatible with gamepad inputs.
-You can refer to the ImGui gamepad controls:
-
-![ImGui controls](./imgui_controls_v6_Xbox.png)
diff --git a/docs/Usage.md b/docs/Usage.md
new file mode 100644
index 0000000..f9ad119
--- /dev/null
+++ b/docs/Usage.md
@@ -0,0 +1,131 @@
+# How to use GlosSI đ
+
+## Table of contents
+
+- [How to use GlosSI đ](#how-to-use-glossi-)
+ - [Table of contents](#table-of-contents)
+ - [Installation đŋ](#installation-)
+ - [Installer](#installer)
+ - [.zip file](#zip-file)
+ - [Usage đšī¸](#usage-ī¸)
+ - [Prerequisites đ¨](#prerequisites-)
+ - [Quick usage âąī¸ (Handy for troubleshooting!)](#quick-usage-ī¸-handy-for-troubleshooting)
+ - [Comfy usage đ§¸](#comfy-usage-)
+ - [Configuration âī¸](#configuration-ī¸)
+ - [Pre-Launch configuration (GlosSIConfig)](#pre-launch-configuration-glossiconfig)
+ - [On-the-fly configuration (GlosSI overlay)](#on-the-fly-configuration-glossi-overlay)
+ - [Neat tips and tricks đ](#neat-tips-and-tricks-)
+
+## Installation đŋ
+
+### Installer
+
+- Install, Reboot, Go! đī¸
+
+### .zip file
+
+1. Extract the .zip-file to any directory on your computer
+2. Install vc_redist_x64.msi
+3. Install ViGEmBusSetup_x64.exe
+4. Install HidHideSetup.exe
+5. **Reboot(!)**
+
+That's it! You're ready to use GlosSI đ
+
+## Usage đšī¸
+
+### Prerequisites đ¨
+
+- Enable "XBox configuration support" in Steam
+- Have Steam running
+
+### Quick usage âąī¸ (Handy for troubleshooting!)
+
+1. Add `GlosSITarget.exe` as a non-Steam Game to Steam
+2. Setup controller configuration for the newly added shortcut in Steam
+3. Launch _GlosSITarget_ from Steam
+
+That's it! đ
+You can now launch any game/application just like you would without Steam.
+Enjoy global SteamInput as well as a systemwide Steam overlay. đģđŽ
+
+**Please note:**
+The overlay only works with _borderless window_ mode, **not** _exclusive fullscreen_.
+
+In this mode, the overlay also does not work with UWP (â Windows Store)
+(When not manually enabled in GlosSI-overlay after launch)
+See [Comfy usage](#-comfy-usage), [configuration](#-configuration)
+
+---
+
+### Comfy usage đ§¸
+
+Since launching one thing from Steam and then launching a game outside of Steam is tedious, and leaves you with only a single controller configuration, GlosSI provides a handy shortcut-management and config app
+
+Here's the basic gist to get you up and running using GlosSI
+
+1. Launch GlosSIConfig.exe
+2. Click the â-button to add a new shortcut that GlosSI should manage
+3. Select the type of app you want GlosSI to launch for you
+
+- Select _UWP App_ for Windows-Store Apps
+- Select _Win32 Program_ for "classic" programs and games
+- Select _Add Manually_ in case you don't want GlosSI to launch anything or want to set up game launching at a later stage.
+ - **If** you have selected _Add Manually_ enter the desired name for the shortcut
+
+1. Click the _đž Save_-button
+2. Click the _â to Steam_-button
+3. _Optional_ Repeat steps 2-5 if you want to add multiple shortcuts
+4. **Restart Steam**
+5. Setup controller configuration for the newly added shortcut in Steam
+6. Search and launch your newly added shortcut from Steam
+
+That's it! đ
+GlosSI should now launch your game, draw the SteamOverlay on top of it (_borderless window_ and _UWP_ only) and provide controller input redirection. đģđŽ
+
+
+ Screenies đ¸
+
+![steps-gif](./glossi_add_shortcut.gif)
+
+
+
+## Configuration âī¸
+
+### Pre-Launch configuration (GlosSIConfig)
+
+GlosSIConfig provides a fair share of configuration options to tweak features to your liking as well as aid in troubleshooting.
+Most of the options have a `?`-button next to them that will provide a short description of what the option does.
+
+You do not need to worry about the advanced options too much, though, as the sane defaults should work for most supported use-cases
+
+### On-the-fly configuration (GlosSI overlay)
+
+Most, if not all, configuration options that are available in GlosSIConfig can also be changed on the fly using the GlosSI overlay.
+
+To open/close the GlosSI overlay, open and close the SteamOverlay twice in rapid succession.
+
+The GlosSI overlay can also be navigated with controller-inputs
+
+
+ Screenies đ¸
+
+![overlay-screenie](./overlay_screenie.png)
+![overlay-controller-controls-screenie](./imgui_controls_v6_Xbox.png)
+
+
+
+## Neat tips and tricks đ
+
+- Want to use Steam community controller configs for a game you bought on a different store than Steam?
+
+ Rename the shortcut in Steam to the Steam-AppID of the game you want to access to community-configs.
+ Community configs may only be available **before** you launch the shortcut.
+ AppIDs can be retrieved from [SteamDB](https://steamdb.info/apps/)
+
+
+ Screenie đ¸
+
+ ![appid-trick](./appid_trick.png)
+
+
\ No newline at end of file
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index 6b112b0..0000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-plugins:
- - jekyll-relative-links
- - jekyll-remote-theme
-relative_links:
- enabled: true
- collections: true
-title: GlosSI
-show_downloads: true
-#remote_theme: mmistakes/jekyll-theme-basically-basic
-remote_theme: pages-themes/minimal
-logo: assets/img/logo.png
-github:
- release_url: https://github.com/Alia5/GlosSI/releases
- snapshot_url: https://ci.appveyor.com/project/Alia5/glossi/build/artifacts
- repository_url: https://www.github.com/Alia5/GlosSI
\ No newline at end of file
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index 762b170..0000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
-
-
-
-
-
-
-
-{% seo %}
-
-
- {% include head-custom.html %}
-
-
-
-
-
-
-
-
-
diff --git a/docs/appid_trick.png b/docs/appid_trick.png
new file mode 100644
index 0000000..0d6c51d
Binary files /dev/null and b/docs/appid_trick.png differ
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
deleted file mode 100644
index 9bf42c4..0000000
--- a/docs/assets/css/style.scss
+++ /dev/null
@@ -1,34 +0,0 @@
----
----
-
-@import "{{ site.theme }}";
-
-body {
- font: 18px/1.5 "Noto Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
-}
-
-.wrapper {
- margin-left: 120px;
- margin-right: 120px;
- width: calc(100% - 548px);
-}
-
-section {
- width: calc(100% - 294px - 96px);
-}
-
-ul.downloads {
- height: 56px;
- a {
- strong {
- position: relative;
- top: 50%;
- -ms-transform: translateY(-50%);
- transform: translateY(-50%);
- }
- }
-}
-
-footer {
- margin-top: 800px;
-}
\ No newline at end of file
diff --git a/docs/assets/img/logo.png b/docs/assets/img/logo.png
deleted file mode 100644
index 93e608e..0000000
Binary files a/docs/assets/img/logo.png and /dev/null differ
diff --git a/docs/glossi_add_shortcut.gif b/docs/glossi_add_shortcut.gif
new file mode 100644
index 0000000..40e563b
Binary files /dev/null and b/docs/glossi_add_shortcut.gif differ
diff --git a/docs/glossi_overlay.png b/docs/glossi_overlay.png
deleted file mode 100644
index f48b0f4..0000000
Binary files a/docs/glossi_overlay.png and /dev/null differ
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 26c345b..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
----
-
-# ATTENTION: GloSC is currently being rewritten, and renamed to GlosSI ([Glo]bal ([s]ystemwide) [S]team [I]nput)
-
-No ETA when it's done
-No support until then.
-
-**Looking for contributors!**
-As the past has shown, I have way to less time on hand too maintain such a project.
-Reach out via Discord/E-Mail (But get to the point right away, please, I get way too much spam)
-
-See: [BUILDING](./BUILDING.md) / [CONTRIBUTING](https://github.com/Alia5/GlosSI/blob/main/CONTRIBUTING.md)
-
-# GlosSI
-
-GlosSI or [Glo]bal ([s]ystemwide) [S]team [I]nput, formerly knows as GloSC (Global Steam Controller), is a tool that allows one to use Steam-Input controller rebinding at a system-level alongside a system wide (borderless window) Steam overlay
-All complete with **per application bindings and working rumble emulation.**
-GlosSI can, but isn't required to, launch any of your favorite games or applications and directly add them to Steam, be it Win32 or Windows Store (UWP)!
-It is **the tool** to enjoy any game that has trouble with Steam and/or *add extra functionality* to your Steam-Input needs
-
-*Windows Store*, *Reshade / SweetFX*, *Origin*, *Uplay*, *Emulators* and *more* with **no hassle**âĸ
-
-GlosSI provides its [own overlay](./Overlay.md), in addition to that of Steam.
-
-## How does it work? / What does it do?
-
-GlosSI creates and adds a (or multiple) non-Steam shortcuts to Steam. When one of those is launched, a transparent, borderless window appears in which you can use the Steam-overlay. You also get access to touch- and radial-menus and other functionality normally only present in Games
-
-In addition to that, Gamecontroller-inputs are redirected to the whole operating system, so that they will work with any game or application
-Real Gamecontrollers are hidden from other applications, so that they can't interfere with your game.
-
-This brings full Steam-Input functionality to the desktop and any other application Steam-Input might not have worked before
-
-Games do not need to be launched using GlosSI.
-If the "Start Application" option does not work, launch any GlosSI-Shortcut from Steam, followed by a game or application.
-
-## What this is not
-
-- a replacement for Steams controller configuration tool.
-- a Steam remote play / steam game streaming solution. (That being said, it **can** work, but is not guaranteed to.)
-- Old versions (GloSC, Global [S]team[C]ontroller) where never designed to be used with anything other than said controller, GlosSI can be used with any controller.
diff --git a/docs/overlay_screenie.png b/docs/overlay_screenie.png
new file mode 100644
index 0000000..e517596
Binary files /dev/null and b/docs/overlay_screenie.png differ