diff --git a/Readme.md b/Readme.md index 6a697df..a48f200 100644 --- a/Readme.md +++ b/Readme.md @@ -12,7 +12,7 @@ No support until then. 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](./BUILDING.md),[CONTRIBUTING.md](./CONTRIBUTING.md) +See: [BUILDING.md](./docs/BUILDING.md),[CONTRIBUTING.md](./CONTRIBUTING.md) # GlosSI @@ -69,7 +69,7 @@ GlosSI is built using [Qt 6.2](https://www.qt.io/) and a fork of [SFML](http://w The system wide Xbox-Controller works via [ViGEm](https://vigem.org/projects/ViGEm/) Device Hiding via [HidHide](https://vigem.org/projects/HidHide/) -For Building instructions refer to [BUILDING.md](./BUILDING.md) +For Building instructions refer to [BUILDING.md](./docs/BUILDING.md) ## License diff --git a/BUILDING.md b/docs/BUILDING.md similarity index 99% rename from BUILDING.md rename to docs/BUILDING.md index 897e4f7..a6d92a6 100644 --- a/BUILDING.md +++ b/docs/BUILDING.md @@ -1,3 +1,6 @@ +--- +--- + # Building GlosSI ## Windows diff --git a/docs/Overlay.md b/docs/Overlay.md new file mode 100644 index 0000000..6fa6fc7 --- /dev/null +++ b/docs/Overlay.md @@ -0,0 +1,16 @@ +--- +--- + +# GlosSI Overlay + +GlosSI provides it's own overlay in addition to that of Steam. + +Simply open/close Steams overlay via your assigned shortcut or the Steam/Guide button **twice** 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/glossi_overlay.png b/docs/glossi_overlay.png new file mode 100644 index 0000000..f48b0f4 Binary files /dev/null and b/docs/glossi_overlay.png differ diff --git a/docs/imgui_controls_v6_Xbox.png b/docs/imgui_controls_v6_Xbox.png new file mode 100644 index 0000000..88ad304 Binary files /dev/null and b/docs/imgui_controls_v6_Xbox.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..985b8e2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,29 @@ +--- +--- + +TODO: Logo + + +# 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.md](./docs/BUILDING.md),[CONTRIBUTING.md](./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.