Merge local with remote

README.md

@@ -2,10 +2,10 @@
 
  It currently should only work on Windows 10 x64, so long as VC Redist 2017 x64 is installed, but it could easily be ported to any other platform (most troublesome is Windows, since it doesn't allow direct access to the hardware without kernel drivers).
 
- **Many thanks to @nagisa for [@nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) (a tool for controlling MSI MBs' RGB LEDs on Linux), which this tool is based on and which made it all the much easier to get going and figure out how the hardware worked.**
+ **Many thanks to @nagisa for [nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) (a tool for controlling MSI MBs' RGB LEDs on Linux), which this tool is based on and which made it all the much easier to get going and figure out how the hardware worked.**
 
 # Motherboard support
- This tool should work out-of-the-box with the following motherboards:
+ This tool **should** work with the following motherboards:
  - MSI B450I GAMING PLUS AC
  - MSI B350I PRO AC
  - MSI A320M GAMING PRO
@@ -35,45 +35,48 @@
  - MSI X399 GAMING PRO CARBON AC
  - MSI X399 SLI PLUS
 
- **Important: Scroll down to License for information on warranty**.
+ **Important: See [License](#license) for information on warranty**.
 
 # Confirmed supported motherboards
  - MSI B450I GAMING PLUS AC
 
  **There are other boards not supported by Mystic Light which reportedly work as well. One case is MSI B350M MORTAR ARCTIC. It may be that they're instead supported in MSI's Gaming App, which I did not look into. It is still possible to use this tool with any motherboard that isn't listed above by passing the --ignore-check flag to it, but do it at your own risk.**
 
- **Some boards which [@nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) is reportedly working with and are part of the list above are as follows (and so should work with this tool as well):**
+ **Some boards which [nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) is reportedly working with and are part of the list above are as follows (and so should work with this tool as well):**
  - MSI H270M MORTAR ARTIC
  - MSI X470 GAMING PRO
  - MSI X470 GAMING PLUS
  - MSI Z270 SLI PLUS
  - MSI Z370M MORTAR
 
 # Examples
-## Static colours on motherboard that _supposedly_ only supports 7 colours
-![](https://i.imgur.com/mBC6klW.jpg =250x250)
-![](https://i.imgur.com/5Dan3JZ.jpg =250x250)
-![](https://i.imgur.com/HHjLiK4.jpg =250x250)
-![](https://i.imgur.com/2NEy0Du.jpg =250x250)
-![](https://i.imgur.com/yl8oXdo.jpg =250x250)
-![](https://i.imgur.com/YJ0xYqD.jpg =250x250)
-![](https://i.imgur.com/ywdEWCY.jpg =250x250)
-![](https://i.imgur.com/nPzac8f.jpg =250x250)
-![](https://i.imgur.com/DhaTctC.jpg =250x250)
+## Hue wheel (ported from [nagisa/msi-rgb](https://github.com/nagisa/msi-rgb))
+![animation of hue wheel](https://thumbs.gfycat.com/CanineShorttermAdamsstaghornedbeetle-size_restricted.gif)
 
-## Hue wheel
-[In a moment]
+This example can be found in examples/hue_wheel.py. It requires you to install Python. In order to run the example, you need to set an environment variable in the command line beforehand pointing to MSIRGB's EXE, like this: `set MSIRGB_PATH=../x64/Release/MSIRGB.exe`
 
 # License
- The code is licensed under the ISC license - the same one that [@nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) uses. You're free to use, modify, redistribute and even use it in any commercial projects so long as you keep the copyright notice. **Be aware that this means I provide no warranty whatsoever should your motherboard malfunction**.
+ The code is licensed under the ISC license - the same one that [nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) uses. You're free to use, modify, redistribute and even use it in any commercial projects so long as you keep the copyright notice. **Be aware that this means I provide no warranty whatsoever should your motherboard malfunction**.
 
 # How to use
  1. Download the [latest release](https://github.com/ixjf/MSIRGB/releases/latest).
  2. Install [VC Redist 2017 x64](https://aka.ms/vs/15/release/vc_redist.x64.exe).
  3. Run the command line as administrator (the tool requires such privileges to load a kernel driver needed to access the hardware).
- 4. Run MSIRGB.exe with the command `MSIRGB.exe -h`. That should present all available commands. To see options for LED configuration, run `MSIRGB.exe config -h`. To disable the LEDs, run `MSIRGB.exe disable`. To run any command with an unsupported motherboard, run `MSIRGB.exe --ignore-check <command>`. Here's an example: 
+ 4. Run MSIRGB.exe with the command `MSIRGB.exe -h`. That should present all available commands. To see options for LED configuration, run `MSIRGB.exe config -h`. 
+
+ You can: 
+ - Disable the LEDs, by running `MSIRGB.exe disable`.
+ - Change LED colour (there are 4 different values for colour, hardware implemented, which the chip loops through every x time, whose value is set by the -d option).
+ - Set LED breathing mode enabled/disabled. (turns on/off smoothly)
+ - Set LED flashing mode enabled/disabled. (turns on/off instantly)
+ - Set step duration. (as I said above, the -d option)
+ - Set channels inverted.
+ - Enable some fade-in effect that I ported over from [nagisa/msi-rgb](https://github.com/nagisa/msi-rgb) but which only works with certain boards. (There are other effects, but those also seem to work only on some boards)
+ - Run any command with an unsupported motherboard, with `MSIRGB.exe --ignore-check <command>`. 
+
+ Here's an example for changing LED config (sets colour to 0xffee11, flashing mode disabled, step duration set to max, breathing mode enabled): `MSIRGB.exe config 0xffee11 0xffee11 0xffee11 0xffee11 -f0 -d511 -b`
 
 # How to build
- 1. Install Visual Studio 2017 (any version) with C++ desktop development tools. The project is currently set to use the Windows 10 SDK from build 17663, but it should work with any other version.
+ 1. Install Visual Studio 2017 (any edition) with C++ desktop development tools. The project is currently set to use the Windows 10 SDK build 17663, but it should work with any other.
  2. Open the solution (MSIRGB.sln)
  3. Select debug/release target & build.

examples/hue_wheel.py

@@ -1,3 +1,20 @@
+# ISC License
+#
+# Copyright © 2017, Simonas Kazlauskas
+# Copyright © 2018, Pedro Fanha
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above1
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE.
+
 import colorsys, time, subprocess, os
 
 process_path = os.getenv('MSIRGB_PATH')
@@ -26,4 +43,4 @@
 
   subprocess.call([process_path, 'config', '-d511', '-f0', str(c1), str(c2), str(c3), str(c4)])
   time.sleep(0.1)
-  i+=1
+  i+=1