Merge branch 'main' into release

.gitignore

@@ -2,4 +2,5 @@
 sf.json
 phue-rf-save.json
 __pycache__/*
-external/__pycache__/*
+external/__pycache__/*
+external/modified/__pycache__/*

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Othneil Drew
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,35 +1,164 @@
-# phue-racing-flags
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
 
-## What is phue-racing-flags?
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <h3 align="center">phue-racing-flags</h3>
 
-phue-racing-flags is a small tool written in Python, that allows you to use your Philips Hue lights to display the current racing flag of your Assetto Corsa Competizione Race.
+  <p align="center">
+    Use your Philips Hue lights as Racing Flags.
+    <br />
+    <br />
+    <a href="https://github.com/TUnbehaun/phue-racing-flags"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/TUnbehaun/phue-racing-flags/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/TUnbehaun/phue-racing-flags/issues">Request Feature</a>
+  </p>
+</p>
 
-## What does it look like?
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li><a href="#supported-systems-and-racing-simulators">Supported Systems and Racing Simulators</a></li>
+    <li>
+      <a href="#local-development">Local Development</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li><li>
+        <a href="#run-the-app">Run the app</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgements">Acknowledgements</a></li>
+    <li><a href="#disclaimer">Disclaimer</a></li>
+  </ol>
+</details>
 
-The design of the app tries to resemble the design of motorsport dashboards like Bosch's DDU systems.
+<!-- ABOUT THE PROJECT -->
+## About The Project
 
-![grafik](https://user-images.githubusercontent.com/12392728/120864997-75105f80-c58d-11eb-9492-2bbec0c6bcf8.png)
+![grafik](https://user-images.githubusercontent.com/12392728/120937234-b11dfe80-c70c-11eb-87bf-3c58046e0905.png)
 
-## How do I use it?
+One Friday evening I thought to myself that it would be pretty sweet to use my Philips Hue lights as indicators for the racing flags inside of Assetto Corsa Competizione. As no app was available to achieve this, I decided to take matters into my own hand and create one.
 
-1. Download the .exe file from here: https://github.com/TUnbehaun/phue-racing-flags/releases/latest/download/phue-racing-flags.exe
+### Built With
+
+* [Python](https://www.python.org/)
+
+## Supported Systems and Racing Simulators
+
+The app is designed for Windows and currently supports the following racing simulators:
+* [Assetto Corsa Competizione](https://www.assettocorsa.it/competizione/)
+* [iRacing](https://www.iracing.com/)
+
+<!-- GETTING STARTED -->
+## Local Development
+
+To get a local development copy up and running follow these simple steps.
+
+### Prerequisites
+
+* Python
+  https://www.python.org/downloads/
+
+### Installation
+
+* Clone the repo
+   ```sh
+   git clone https://github.com/TUnbehaun/phue-racing-flags.git
+   ```
+### Run the app
+
+* Start the GUI
+  ```sh
+   python gui.py
+   ```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+To just use the app itself without setting up a local development copy, you can follow these simple steps:
+
+1. Download the latest .exe file from here: https://github.com/TUnbehaun/phue-racing-flags/releases/latest/download/phue-racing-flags.exe
 2. Run the .exe file
-3. Enter the IP Address of your Philips Hue Bridge in the "bridge ip" input field.
+
+Once the app is started, you can use it the following way:
+
+1. Enter the IP Address of your Philips Hue Bridge in the "bridge ip" input field.
 (You can find the IP Address of your Bridge in the interface of your Router)
-5. Press the (hardware) link button on your Philips Hue Bridge and then within 30 seconds hit the "Connect" button in the app.
+2. Press the (hardware) link button on your Philips Hue Bridge and then within 30 seconds hit the "Connect" button in the app.
 (Pressing the (hardware) link button on your Philips Hue Bridge is only necessary for the very first time you connect the app to a new Bridge)
-6. You should be able to choose one of your lights under "flag light" to use as the Racing Flag Light
-7. Test the Racing Flag Light by using the buttons under "color test"
-8. Adjust brightness if needed
-9. To start syncing the Racing Flag Light with the Assetto Corsa Competizione Race Flag click "Start" under "acc sync"
-10. To stop syncing the Racing Flag Light with the ACC Race Flag click "Stop" under "acc sync"
+3. You should be able to choose one or multiple of your lights under "flag light" to use as the Racing Flag Light(s)
+4. Use the radio buttons under "sim" to switch between Assetto Corsa Competizione or iRacing.
+5. Test the Racing Flag Light(s) by using the buttons under "color test".
+6. Adjust brightness if needed.
+7. To start syncing the Racing Flag Light(s) with your simulator's race flag click "Start" under "live sync".
+8. To stop syncing the Racing Flag Light(s) click "Stop" under "live sync".
+
+<!-- ROADMAP -->
+## Roadmap
+
+See the [open issues](https://github.com/TUnbehaun/phue-racing-flags/issues) for a list of proposed features (and known issues).
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+Tim Unbehaun - [email protected]
+
+Project Link: [https://github.com/TUnbehaun/phue-racing-flags](https://github.com/TUnbehaun/phue-racing-flags)
+
+<!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+
+* [phue](https://github.com/studioimaginaire/phue)
+* [PySimpleGui](https://github.com/PySimpleGUI/PySimpleGUI)
+* [PyInstaller](http://www.pyinstaller.org/)
+* [pyirsdk](https://github.com/kutu/pyirsdk)
 
-## What is the sf.json file used for?
+## Disclaimer
 
-The sf.json file is used for storing your last entries for "bridge ip", "flag light" and "brightness". This brings the convencience, that upon restart of the app, everything is just as you left it. The sf.json file has to be located in the same folder as the .exe file for this to work.
+I am in no way affiliated with Philips, Kunos Simulazioni or iRacing.
 
-## What is planned for the future?
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[forks-shield]: https://img.shields.io/github/forks/TUnbehaun/phue-racing-flags.svg?style=for-the-badge
+[forks-url]: https://github.com/TUnbehaun/phue-racing-flags/network/members
+[stars-shield]: https://img.shields.io/github/stars/TUnbehaun/phue-racing-flags.svg?style=for-the-badge
+[stars-url]: https://github.com/TUnbehaun/phue-racing-flags/stargazers
+[issues-shield]: https://img.shields.io/github/issues/TUnbehaun/phue-racing-flags.svg?style=for-the-badge
+[issues-url]: https://github.com/TUnbehaun/phue-racing-flags/issues
+[license-shield]: https://img.shields.io/github/license/TUnbehaun/phue-racing-flags.svg?style=for-the-badge
+[license-url]: https://github.com/TUnbehaun/phue-racing-flags/blob/master/LICENSE.txt
 
-* Enabling a custom color mapping per flag
-* Supporting other sims like iRacing, rFactor, RaceRoom, etc.
-* Enabling the mapping of other racing metrics to Philips Hue lights (motor revs, time delta, etc.)