Initial release of the public version

.gitignore

@@ -0,0 +1,6 @@
+*.pro.user
+*.directory
+node_modules
+bower_components
+*.bak
+*~

BeneOverlay.pro

@@ -0,0 +1,63 @@
+QT += qml quick webchannel websockets widgets
+
+CONFIG += c++11
+
+HEADERS += \
+    include/dataref.h \
+    include/datarefmanager.h \
+    include/websocketclientwrapper.h \
+    include/websockettransport.h \
+    include/version.h \
+    include/updatemanager.h
+
+win32: HEADERS += include/flightsimconnector.h
+
+SOURCES += \
+    src/dataref.cpp \
+    src/datarefmanager.cpp \
+    src/main.cpp \
+    src/websocketclientwrapper.cpp \
+    src/websockettransport.cpp \
+    src/updatemanager.cpp
+
+win32: SOURCES += src/flightsimconnector.cpp
+
+INCLUDEPATH += include/
+
+RC_ICONS = images/logo.ico
+
+# Additional import path used to resolve QML modules in Qt Creator's code model
+QML_IMPORT_PATH =
+
+# Additional import path used to resolve QML modules just for Qt Quick Designer
+QML_DESIGNER_IMPORT_PATH =
+
+# The following define makes your compiler emit warnings if you use
+# any feature of Qt which as been marked deprecated (the exact warnings
+# depend on your compiler). Please consult the documentation of the
+# deprecated API in order to know how to port your code away from it.
+DEFINES += QT_DEPRECATED_WARNINGS
+
+# You can also make your code fail to compile if you use deprecated APIs.
+# In order to do so, uncomment the following line.
+# You can also select to disable deprecated APIs only up to a certain version of Qt.
+#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000    # disables all the APIs deprecated before Qt 6.0.0
+
+# Default rules for deployment.
+qnx: target.path = /tmp/$${TARGET}/bin
+else: unix:!android: target.path = /opt/$${TARGET}/bin
+!isEmpty(target.path): INSTALLS += target
+
+
+DISTFILES +=
+
+RESOURCES += \
+    qml/qml_resources.qrc \
+    data_resources.qrc
+
+win32: LIBS += -L$$PWD/fsuipc/ -lFSUIPC_User
+
+INCLUDEPATH += $$PWD/fsuipc/
+DEPENDPATH += $$PWD/fsuipc/
+
+win32: PRE_TARGETDEPS += $$PWD/fsuipc/FSUIPC_User.lib

README.md

@@ -1 +1,84 @@
-BeneOverlay
+# About
+BeneOverlay by BeneSim is free software distributed under the GNU General Public
+License, Version 3.
+It was designed to enhance the experience for viewers of flight sim streams.
+Often times it is very hard to see some of the interesting data of the current
+flight, like altitude, heading and speed. In fact, if you are not inside the
+virtual cockpit it might even be impossible to get hold of these information.
+
+This is where BeneOverlay comes into play. It uses the FSUIPC SDK to communicate
+with your favorite flight sim and extracts all the important data and embeds
+them into a website. By simply including this website into your preferred
+streaming client you're viewers are always aware of what's going on in the sim.
+
+# Prerequisites
+Since BeneOverlay uses the FSUIPC SDK to communicate with the flight sim, you
+need to have FSUIPC (FSX/P3D) or XPUIPC (XP10/11) installed. The unregistered
+version of FSUIPC is sufficient.
+
+Download FSUIPC (FSX/P3D): http://www.schiratti.com/dowson.html  
+Download XPUIPC (XP10/11): http://www.tosi-online.de/XPUIPC/XPUIPC.html
+
+# Installation
+BeneOverlay ships as a `*.zip` file. Simply unzip the file to a directory of
+your liking. No installation required. Once unzipped run `BeneOverlay.exe`. On
+first start it will create a `html` folder. Within this `html` folder are the
+`*.html` files you want to include in your streaming software. 
+
+* `widgets.html` This is the main widget. It displays all kinds of information
+like heading, altitude, speed etc.
+* `progress.html` Displays your departure and arrival airport. The distance
+between those airports and the distance to go as well as the ETA.
+* `landing.html` Displays you vertical speed, pitch, bank and speed on touchdown
+* `*.html` All other file are the individual widgets found in `widgets.html`. If
+you prefer to include and position each widget individually feel free to do so.
+
+BeneOverlay has been extensively tested with OBS Studio, thus I highly
+recommend to use it as your streaming software.
+
+## OBS Studio Setup
+In order to render `*.html` files in OBS Studio you need the **BrowserPlugin**.
+In recent versions of OBS Studio the **BrowserPlugin** will be installed by
+default.
+
+Adding the BeneOverlay `*.html` files is straight forward. With OBS Studio
+opened locate the `Sources` tab and click on `Add` (indicated by a `+`). Select
+`Browser Source`, select `Create new`, chose a meaningful name e.g.
+`beneoverlay-widgets` and click on `OK`.
+
+In the config dialog check `Local file`
+and browse to the html file you want to add e.g. `widgets.html`. Now select and
+copy the contents of the `Local file` field. Uncheck `Local file` and paste the
+previously copied file path into the `URL` field.  
+Technically all `*.html` files
+of BeneOverlay can be included as local files. However, the `landing.html` must
+not be included as a local file, else selecting a background image would have
+no effect.  
+Now enter the desired `width` and `height` of the widget and click `OK`. I
+recommend to chose the size generously. Scaling of the widgets should be
+performed within the BeneOverlay software itself and not within OBS Studio using
+the `Icon Size` and `Font` settings.
+
+A final step would be to drag the widgets on the scene to the positions you
+prefer.
+
+# Usage
+The GUI should be pretty self explanatory. I might include a manual in future
+versions. If you need help using the software feel free to contact me. The best
+place would be my discord server.
+
+https://discord.gg/nkwz4Dg
+
+# License
+BeneOverlay is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+BeneOverlay is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with BeneOverlay. If not, see <http://www.gnu.org/licenses/>.