From 0d016bedccaa26337e8c2355e77ef8114901226a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20H=C3=B6glinger?= Date: Sun, 1 Jul 2018 19:55:23 +0200 Subject: [PATCH] Added build instructions Added disclaimer Minor change of wording --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3647e76..69e5e24 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Windows kernel-mode driver emulating well-known USB game controllers. )](https://ci.appveyor.com/project/nefarius/indicium-supra) [![Discord](https://img.shields.io/discord/346756263763378176.svg)](https://discord.gg/QTJpBX5) [![Website](https://img.shields.io/website-up-down-green-red/https/vigem.org.svg?label=ViGEm.org)](https://vigem.org/) [![PayPal Donate](https://img.shields.io/badge/paypal-donate-blue.svg)]() [![Support on Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)]() [![GitHub followers](https://img.shields.io/github/followers/nefarius.svg?style=social&label=Follow)](https://github.com/nefarius) [![Twitter Follow](https://img.shields.io/twitter/follow/nefariusmaximus.svg?style=social&label=Follow)](https://twitter.com/nefariusmaximus) ## About +**Disclaimer:** this project is for software developers. To make it do something useful you'll also need a [feeder application](). + The `ViGEmBus` driver and `ViGEmClient` libraries represent the core of the Virtual Gamepad Emulation Framework (or `ViGEm` , for short). `ViGEm` aims for a 100% accurate [emulation]() of well-known gaming peripherals as pure software-based devices at kernel level. As it mimics "the real thing" games and other processes require no additional modification whatsoever to detect `ViGEm`-based devices (no Proxy-DLLs or API-Hooking) and simply work out of the box. While the (now obsolete) [Scarlett.Crush Productions Virtual Bus Driver]() is the spiritual father of this project, `ViGEm` has been designed and written from the ground up utilizing Microsoft's [Kernel-Mode Driver Framework](https://en.wikipedia.org/wiki/Kernel-Mode_Driver_Framework). ### Emulated devices @@ -25,8 +27,22 @@ A few examples of the most common use cases for `ViGEm` are: ## Supported Systems The driver is built for Windows 7/8/8.1/10 (x86 and amd64). +## How to build + +### Prerequisites + - Visual Studio **2017** ([Community Edition](https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community&rel=15) is just fine) + - [WDK for Windows 10, version 1803](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit) + + You can either build directly within Visual Studio or in PowerShell by running the build script: + + ``` + .\build.ps1 -configuration release + ``` + + Do bear in mind that you'll need to sign the driver to use it without [test mode](). + ## Installation -[Follow the installation instructions](). +To grab the latest signed binaries for use or redistribution [follow the installation instructions](). ### Necessary preparations for Windows 7 Before installing the bus driver on Windows 7 (x86 or x64) the following 3rd party software has to be installed: