Document the --version option

Reviewed-on: #760

.github/workflows/appimage.yml

@@ -0,0 +1,98 @@
+name: "ci"
+
+on:
+  push:
+    tags: "**"
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  appimage:
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        submodules: true
+
+    - name: Install dependencies
+      run: |
+        sudo add-apt-repository -y ppa:beineri/opt-qt-5.15.2-bionic
+        sudo apt-get update -qq
+        sudo apt-get install -y \
+        build-essential make wget libgl1-mesa-dev \
+        qt515declarative qt515graphicaleffects \
+        qt515quickcontrols qt515quickcontrols2
+
+    - name: Download QT appimage builder
+      run: |
+        wget -c -O linuxdeployqt.AppImage \
+        https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage
+        chmod a+x linuxdeployqt.AppImage
+
+    - name: Build project
+      run: |
+        source /opt/qt*/bin/qt*-env.sh && \
+        qmake -v && \
+        qmake CONFIG+=release PREFIX=/usr && \
+        make -j$(nproc)
+
+    - name: Install to appdir
+      run: |
+        source /opt/qt*/bin/qt*-env.sh && \
+        make INSTALL_ROOT=appdir -j$(nproc) install
+
+    - name: Extract version number
+      run: |
+        # Extract version for linuxdeployqt to name the file. Use the tag as
+        # release name but remove prefix.
+        echo "VERSION=$(echo '${{ github.ref }}' | sed 's;.*/;;')" >> $GITHUB_ENV
+
+    - name: Build appimage directory
+      run: |
+        mkdir -p \
+        appdir/usr/bin \
+        appdir/usr/lib \
+        appdir/usr/share/applications \
+        appdir/usr/share/metainfo \
+        appdir/usr/share/icons/hicolor/128x128/apps
+
+        cp cool-retro-term appdir/usr/bin/
+        cp cool-retro-term.desktop appdir/usr/share/applications/
+        cp packaging/appdata/cool-retro-term.appdata.xml appdir/usr/share/metainfo/
+        cp app/icons/128x128/cool-retro-term.png appdir/usr/share/icons/hicolor/128x128/apps/
+        cp -r ./app/qml appdir/usr/
+        # Workaround for https://github.com/probonopd/linuxdeployqt/issues/78
+        cp -r ./qmltermwidget/QMLTermWidget appdir/usr/qml/
+
+        find appdir | sort
+
+    - name: Build appimage
+      run: |
+        source /opt/qt*/bin/qt*-env.sh && \
+        ./linuxdeployqt.AppImage appdir/usr/share/applications/cool-retro-term.desktop \
+        -verbose=1 -appimage \
+        -qmldir=./app/qml/ \
+        -qmldir=./qmltermwidget/
+      env:
+        # Unset environment variables
+        QTDIR:
+        QT_PLUGIN_PATH:
+        LD_LIBRARY_PATH:
+
+    - name: Upload release
+      uses: softprops/action-gh-release@v1
+      with:
+        body: appimage release
+        files: ./**/Cool_Retro_Term-*-x86_64.AppImage
+
+    - name: Clean up
+      if: always()
+      run: |
+        find appdir -executable -type f -exec ldd {} \; | grep " => /usr" | cut -d " " -f 2-3 | sort | uniq
+        make clean
+        rm -rf appdir

app/app.pro

@@ -16,7 +16,7 @@ macx:ICON = icons/crt.icns
 RESOURCES += qml/resources.qrc
 
 #########################################
-##              INTALLS
+##              INSTALLS
 #########################################
 
 target.path += /usr/bin/

app/main.cpp

@@ -49,16 +49,16 @@ int main(int argc, char *argv[])
 
     if (argc>1 && (!strcmp(argv[1],"-h") || !strcmp(argv[1],"--help"))) {
         QTextStream cout(stdout, QIODevice::WriteOnly);
-        cout << "Usage: " << argv[0] << " [--default-settings] [--workdir <dir>] [--program <prog>] [-p|--profile <prof>] [--fullscreen] [-h|--help]" << endl;
-        cout << "  --default-settings  Run cool-retro-term with the default settings" << endl;
-        cout << "  --workdir <dir>     Change working directory to 'dir'" << endl;
-        cout << "  -e <cmd>            Command to execute. This option will catch all following arguments, so use it as the last option." << endl;
-        cout << "  -T <title>          Set window title to 'title'." << endl;
-        cout << "  --fullscreen        Run cool-retro-term in fullscreen." << endl;
-        cout << "  -p|--profile <prof> Run cool-retro-term with the given profile." << endl;
-        cout << "  -h|--help           Print this help." << endl;
-        cout << "  --verbose           Print additional information such as profiles and settings." << endl;
-        cout << "  -v|--version        Print the program name and version." << endl;
+        cout << "Usage: " << argv[0] << " [--default-settings] [--workdir <dir>] [--program <prog>] [-p|--profile <prof>] [--fullscreen] [-h|--help]" << '\n';
+        cout << "  --default-settings  Run cool-retro-term with the default settings" << '\n';
+        cout << "  --workdir <dir>     Change working directory to 'dir'" << '\n';
+        cout << "  -e <cmd>            Command to execute. This option will catch all following arguments, so use it as the last option." << '\n';
+        cout << "  -T <title>          Set window title to 'title'." << '\n';
+        cout << "  --fullscreen        Run cool-retro-term in fullscreen." << '\n';
+        cout << "  -p|--profile <prof> Run cool-retro-term with the given profile." << '\n';
+        cout << "  -h|--help           Print this help." << '\n';
+        cout << "  --verbose           Print additional information such as profiles and settings." << '\n';
+        cout << "  -v|--version        Print the program name and version." << '\n';
         return 0;
     }
 
@@ -66,7 +66,7 @@ int main(int argc, char *argv[])
 
     if (argc>1 && (!strcmp(argv[1],"-v") || !strcmp(argv[1],"--version"))) {
         QTextStream cout(stdout, QIODevice::WriteOnly);
-        cout << "cool-retro-term " << appVersion << endl;
+        cout << "cool-retro-term " << appVersion << '\n';
         return 0;
     }
 

app/qml/ApplicationSettings.qml

@@ -32,7 +32,7 @@ QtObject {
     readonly property real maximumFontScaling: 2.50
 
     readonly property real minBurnInFadeTime: 160
-    readonly property real maxBurnInFadeTime: 1600
+    readonly property real maxBurnInFadeTime: 160000
 
     property bool isMacOS: Qt.platform.os === "osx"
 
@@ -71,6 +71,7 @@ QtObject {
 
     property string _backgroundColor: "#000000"
     property string _fontColor: "#ff8100"
+    property string _frameColor: "#ffffff"
     property string saturatedColor: Utils.mix(Utils.strToColor("#FFFFFF"),
                                               Utils.strToColor(_fontColor),
                                               saturationColor * 0.5)
@@ -81,6 +82,7 @@ QtObject {
                                                   _backgroundColor),
                                               Utils.strToColor(saturatedColor),
                                               0.7 + (contrast * 0.3))
+    property color frameColor: Utils.strToColor(_frameColor)
 
     property real staticNoise: 0.12
     property real screenCurvature: 0.3
@@ -90,6 +92,7 @@ QtObject {
 
     property real chromaColor: 0.25
     property real saturationColor: 0.25
+    property real frameGloss: 0
 
     property real jitter: 0.2
 
@@ -251,11 +254,13 @@ QtObject {
         var settings = {
             "backgroundColor": _backgroundColor,
             "fontColor": _fontColor,
+            "frameColor": _frameColor,
             "flickering": flickering,
             "horizontalSync": horizontalSync,
             "staticNoise": staticNoise,
             "chromaColor": chromaColor,
             "saturationColor": saturationColor,
+            "frameGloss": frameGloss,
             "screenCurvature": screenCurvature,
             "glowingLine": glowingLine,
             "burnIn": burnIn,
@@ -345,6 +350,7 @@ QtObject {
         _backgroundColor = settings.backgroundColor
                 !== undefined ? settings.backgroundColor : _backgroundColor
         _fontColor = settings.fontColor !== undefined ? settings.fontColor : _fontColor
+        _frameColor = settings.frameColor !== undefined ? settings.frameColor : _frameColor
 
         horizontalSync = settings.horizontalSync
                 !== undefined ? settings.horizontalSync : horizontalSync
@@ -353,6 +359,7 @@ QtObject {
         chromaColor = settings.chromaColor !== undefined ? settings.chromaColor : chromaColor
         saturationColor = settings.saturationColor
                 !== undefined ? settings.saturationColor : saturationColor
+        frameGloss = settings.frameGloss !== undefined ? settings.frameGloss : frameGloss
         screenCurvature = settings.screenCurvature
                 !== undefined ? settings.screenCurvature : screenCurvature
         glowingLine = settings.glowingLine !== undefined ? settings.glowingLine : glowingLine
@@ -459,6 +466,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0.2483,
                 "screenCurvature": 0.3,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.1198,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -488,6 +497,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0.0,
                 "screenCurvature": 0.3,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.1198,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -517,6 +528,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0.5,
                 "screenCurvature": 0.3,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.15,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -546,6 +559,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0,
                 "screenCurvature": 0,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.15,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -575,6 +590,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0,
                 "screenCurvature": 0.5,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.099,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -604,6 +621,8 @@ QtObject {
                 "rbgShift": 0.2969,
                 "saturationColor": 0,
                 "screenCurvature": 0.5,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.2969,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -613,7 +632,7 @@ QtObject {
             builtin: true
         }
         ListElement {
-            text: "IBM Dos"
+            text: "IBM DOS"
             obj_string: '{
                 "ambientLight": 0.151,
                 "backgroundColor": "#000000",
@@ -633,6 +652,8 @@ QtObject {
                 "rbgShift": 0.3524,
                 "saturationColor": 0,
                 "screenCurvature": 0.4,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.0503,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -662,6 +683,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0,
                 "screenCurvature": 0.2,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0,
                 "windowOpacity": 1,
                 "margin": 0.5,
@@ -691,6 +714,8 @@ QtObject {
                 "rbgShift": 0,
                 "saturationColor": 0.4983,
                 "screenCurvature": 0,
+                "frameColor": "#ffffff",
+                "frameGloss": 0,
                 "staticNoise": 0.0955,
                 "windowOpacity": 0.7,
                 "margin": 0.1,

app/qml/BurnInEffect.qml

@@ -29,8 +29,8 @@ Loader {
     property real lastUpdate: 0
     property real prevLastUpdate: 0
 
-    property real burnIn: appSettings.burnIn
-    property real burnInFadeTime: 1 / Utils.lint(_minBurnInFadeTime, _maxBurnInFadeTime, burnIn)
+    property real burnIn: appSettings.burnIn;
+    property real burnInFadeTime: (1 / Utils.lint(_minBurnInFadeTime, _maxBurnInFadeTime, burnIn))*64
     property real _minBurnInFadeTime: appSettings.minBurnInFadeTime
     property real _maxBurnInFadeTime: appSettings.maxBurnInFadeTime
 
@@ -146,9 +146,8 @@ Loader {
                     float prevMask = accColor.a;
                     float currMask = rgb2grey(txtColor);
 
-                    highp float blurDecay = clamp((lastUpdate - prevLastUpdate) * burnInTime, 0.0, 1.0);
-                    blurDecay = max(0.0, blurDecay - prevMask);
-                    vec3 blurColor = accColor.rgb - vec3(blurDecay);
+                    highp float blurDecay = clamp(pow(0.5, burnInTime * (lastUpdate - prevLastUpdate)), 0.0, 1.0);
+                    vec3 blurColor = accColor.rgb * vec3(blurDecay);
                     vec3 color = max(blurColor, txtColor);
 
                     gl_FragColor = vec4(color, currMask);

app/qml/SettingsTerminalTab.qml

@@ -149,6 +149,11 @@ ColumnLayout {
                     value: appSettings.saturationColor
                     enabled: appSettings.chromaColor !== 0
                 }
+                CheckableSlider {
+                    name: qsTr("Frame Gloss")
+                    onNewValue: appSettings.frameGloss = newValue
+                    value: appSettings.frameGloss
+                }
             }
             RowLayout {
                 Layout.fillWidth: true
@@ -166,6 +171,13 @@ ColumnLayout {
                     onColorSelected: appSettings._backgroundColor = color
                     color: appSettings._backgroundColor
                 }
+                ColorButton {
+                    name: qsTr("Frame")
+                    height: 50
+                    Layout.fillWidth: true
+                    onColorSelected: appSettings._frameColor = color
+                    color: appSettings._frameColor
+                }
             }
         }
     }

app/qml/ShaderTerminal.qml

@@ -37,6 +37,8 @@ Item {
 
     property real ambientLight: appSettings.ambientLight * 0.2
 
+    property real frameGloss: appSettings.frameGloss
+
     property size virtualResolution
     property size screenResolution
 
@@ -59,6 +61,7 @@ Item {
          property real screenCurvature: parent.screenCurvature
          property real chromaColor: parent.chromaColor
          property real ambientLight: parent.ambientLight
+         property real frameGloss: parent.frameGloss
 
          property real flickering: appSettings.flickering
          property real horizontalSync: appSettings.horizontalSync
@@ -172,6 +175,7 @@ Item {
              uniform highp vec4 fontColor;
              uniform highp vec4 backgroundColor;
              uniform lowp float shadowLength;
+             uniform lowp float frameGloss;
 
              uniform highp vec2 virtualResolution;
              uniform lowp float rasterizationIntensity;\n" +
@@ -302,8 +306,8 @@ Item {
 
                  (burnIn !== 0 ? "
                      vec4 txt_blur = texture2D(burnInSource, staticCoords);
-                     float blurDecay = clamp((time - burnInLastUpdate) * burnInTime, 0.0, 1.0);
-                     vec3 burnInColor = 0.65 * (txt_blur.rgb - vec3(blurDecay));
+                     float blurDecay = clamp(pow(0.5, burnInTime * (time - burnInLastUpdate)), 0.0, 1.0);
+                     vec3 burnInColor = txt_blur.rgb * vec3(blurDecay);
                      txt_color = max(txt_color, convertWithChroma(burnInColor));"
                  : "") +
 
@@ -321,7 +325,7 @@ Item {
 
                  (displayTerminalFrame ?
                     "vec4 frameColor = texture2D(frameSource, qt_TexCoord0);
-                     finalColor = mix(finalColor, frameColor.rgb, frameColor.a);"
+                     finalColor = mix(finalColor, frameColor.rgb + (finalColor*frameGloss), frameColor.a);"
                  : "") +
 
                  "gl_FragColor = vec4(finalColor, qt_Opacity);" +

app/qml/TerminalFrame.qml

@@ -22,13 +22,13 @@ import QtQuick 2.0
 import "utils.js" as Utils
 
 ShaderEffect {
-    property color _staticFrameColor: "#fff"
+    property color _frameColor: appSettings.frameColor
     property color _backgroundColor: appSettings.backgroundColor
     property color _fontColor: appSettings.fontColor
     property color _lightColor: Utils.mix(_fontColor, _backgroundColor, 0.2)
     property real _ambientLight: Utils.lint(0.2, 0.8, appSettings.ambientLight)
 
-    property color frameColor: Utils.mix(_staticFrameColor, _lightColor, _ambientLight)
+    property color frameColor: Utils.mix(_frameColor, _lightColor, _ambientLight)
     property real screenCurvature: appSettings.screenCurvature * appSettings.screenCurvatureSize
 
     // Coefficient of the log curve used to approximate shadowing
@@ -87,7 +87,7 @@ ShaderEffect {
             float alpha = 0.0;
 
             float frameShadow = max2(positiveLog(-coords * frameShadowCoeff + vec2(1.0)) + positiveLog(coords * frameShadowCoeff - (vec2(frameShadowCoeff) - vec2(1.0))));
-            frameShadow = max(sqrt(frameShadow), 0.0);
+            frameShadow = clamp(sqrt(frameShadow), 0.0, 1.0);
             color *= frameShadow;
             alpha = sum2(1.0 - step(vec2(0.0), coords) + step(vec2(1.0), coords));
             alpha = clamp(alpha, 0.0, 1.0);