Updates README with a releases link and some rephrasing

2024-05-17 13:40:05 +01:00
9 changed files with 29 additions and 69 deletions
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ It uses the QML port of qtermwidget (Konsole): https://github.com/Swordfish90/qm

 This terminal emulator works under Linux and macOS and requires Qt5. It's suggested that you stick to the latest LTS version.

-Settings such as colors, fonts, and effects can be accessed via context menu.
+Settings such as colors, fonts, and effects can be accessed via the context menu.

 ## Screenshots
 ![Image](<https://i.imgur.com/TNumkDn.png>)
@@ -21,10 +21,10 @@ Settings such as colors, fonts, and effects can be accessed via context menu.

 ## Install

-If you want to get a hold of the latest version, just go to the Releases page and grab the latest AppImage (Linux) or dmg (macOS).
+If you want to get a hold of the latest version, just go to the [Releases](https://github.com/Swordfish90/cool-retro-term/releases) page and grab the latest AppImage (Linux) or dmg (macOS).

 Alternatively, most distributions such as Ubuntu, Fedora or Arch already package cool-retro-term in their official repositories.

 ## Building

-Check out the wiki and follow the instructions on how to build it on [Linux](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(Linux)) and [macOS](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(macOS)).
+Build instructions for [Linux](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(Linux)) and [macOS](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(macOS)) can be found on the wiki.
--- a/app/app.pro
+++ b/app/app.pro
@@ -16,7 +16,7 @@ macx:ICON = icons/crt.icns
 RESOURCES += qml/resources.qrc

 #########################################
-##              INSTALLS
+##              INTALLS
 #########################################

 target.path += /usr/bin/
--- a/app/main.cpp
+++ b/app/main.cpp
@@ -49,15 +49,15 @@ 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]" << '\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 << "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;
        return 0;
    }

@@ -65,7 +65,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 << '\n';
+        cout << "cool-retro-term " << appVersion << endl;
        return 0;
    }

--- a/app/qml/ApplicationSettings.qml
+++ b/app/qml/ApplicationSettings.qml
@@ -32,7 +32,7 @@ QtObject {
    readonly property real maximumFontScaling: 2.50

    readonly property real minBurnInFadeTime: 160
-    readonly property real maxBurnInFadeTime: 160000
+    readonly property real maxBurnInFadeTime: 1600

    property bool isMacOS: Qt.platform.os === "osx"

@@ -71,7 +71,6 @@ 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)
@@ -82,7 +81,6 @@ 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
@@ -92,7 +90,6 @@ QtObject {

    property real chromaColor: 0.25
    property real saturationColor: 0.25
-    property real frameGloss: 0

    property real jitter: 0.2

@@ -254,13 +251,11 @@ 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,
@@ -350,7 +345,6 @@ 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
@@ -359,7 +353,6 @@ 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
@@ -466,8 +459,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0.2483,
                "screenCurvature": 0.3,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.1198,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -497,8 +488,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0.0,
                "screenCurvature": 0.3,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.1198,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -528,8 +517,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0.5,
                "screenCurvature": 0.3,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.15,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -559,8 +546,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0,
                "screenCurvature": 0,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.15,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -590,8 +575,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0,
                "screenCurvature": 0.5,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.099,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -621,8 +604,6 @@ QtObject {
                "rbgShift": 0.2969,
                "saturationColor": 0,
                "screenCurvature": 0.5,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.2969,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -632,7 +613,7 @@ QtObject {
            builtin: true
        }
        ListElement {
-            text: "IBM DOS"
+            text: "IBM Dos"
            obj_string: '{
                "ambientLight": 0.151,
                "backgroundColor": "#000000",
@@ -652,8 +633,6 @@ QtObject {
                "rbgShift": 0.3524,
                "saturationColor": 0,
                "screenCurvature": 0.4,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.0503,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -683,8 +662,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0,
                "screenCurvature": 0.2,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0,
                "windowOpacity": 1,
                "margin": 0.5,
@@ -714,8 +691,6 @@ QtObject {
                "rbgShift": 0,
                "saturationColor": 0.4983,
                "screenCurvature": 0,
-                "frameColor": "#ffffff",
-                "frameGloss": 0,
                "staticNoise": 0.0955,
                "windowOpacity": 0.7,
                "margin": 0.1,
--- a/app/qml/BurnInEffect.qml
+++ b/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))*64
+    property real burnIn: appSettings.burnIn
+    property real burnInFadeTime: 1 / Utils.lint(_minBurnInFadeTime, _maxBurnInFadeTime, burnIn)
    property real _minBurnInFadeTime: appSettings.minBurnInFadeTime
    property real _maxBurnInFadeTime: appSettings.maxBurnInFadeTime

@@ -146,8 +146,9 @@ Loader {
                    float prevMask = accColor.a;
                    float currMask = rgb2grey(txtColor);

-                    highp float blurDecay = clamp(pow(0.5, burnInTime * (lastUpdate - prevLastUpdate)), 0.0, 1.0);
-                    vec3 blurColor = accColor.rgb * vec3(blurDecay);
+                    highp float blurDecay = clamp((lastUpdate - prevLastUpdate) * burnInTime, 0.0, 1.0);
+                    blurDecay = max(0.0, blurDecay - prevMask);
+                    vec3 blurColor = accColor.rgb - vec3(blurDecay);
                    vec3 color = max(blurColor, txtColor);

                    gl_FragColor = vec4(color, currMask);
--- a/app/qml/SettingsTerminalTab.qml
+++ b/app/qml/SettingsTerminalTab.qml
@@ -149,11 +149,6 @@ ColumnLayout {
                    value: appSettings.saturationColor
                    enabled: appSettings.chromaColor !== 0
                }
-                CheckableSlider {
-                    name: qsTr("Frame Gloss")
-                    onNewValue: appSettings.frameGloss = newValue
-                    value: appSettings.frameGloss
-                }
            }
            RowLayout {
                Layout.fillWidth: true
@@ -171,13 +166,6 @@ ColumnLayout {
                    onColorSelected: appSettings._backgroundColor = color
                    color: appSettings._backgroundColor
                }
-                ColorButton {
-                    name: qsTr("Frame")
-                    height: 50
-                    Layout.fillWidth: true
-                    onColorSelected: appSettings._frameColor = color
-                    color: appSettings._frameColor
-                }
            }
        }
    }
--- a/app/qml/ShaderTerminal.qml
+++ b/app/qml/ShaderTerminal.qml
@@ -37,8 +37,6 @@ Item {

    property real ambientLight: appSettings.ambientLight * 0.2

-    property real frameGloss: appSettings.frameGloss
-
    property size virtualResolution
    property size screenResolution

@@ -61,7 +59,6 @@ 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
@@ -175,7 +172,6 @@ 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" +
@@ -306,8 +302,8 @@ Item {

                 (burnIn !== 0 ? "
                     vec4 txt_blur = texture2D(burnInSource, staticCoords);
-                     float blurDecay = clamp(pow(0.5, burnInTime * (time - burnInLastUpdate)), 0.0, 1.0);
-                     vec3 burnInColor = txt_blur.rgb * vec3(blurDecay);
+                     float blurDecay = clamp((time - burnInLastUpdate) * burnInTime, 0.0, 1.0);
+                     vec3 burnInColor = 0.65 * (txt_blur.rgb - vec3(blurDecay));
                     txt_color = max(txt_color, convertWithChroma(burnInColor));"
                 : "") +

@@ -325,7 +321,7 @@ Item {

                 (displayTerminalFrame ?
                    "vec4 frameColor = texture2D(frameSource, qt_TexCoord0);
-                     finalColor = mix(finalColor, frameColor.rgb + (finalColor*frameGloss), frameColor.a);"
+                     finalColor = mix(finalColor, frameColor.rgb, frameColor.a);"
                 : "") +

                 "gl_FragColor = vec4(finalColor, qt_Opacity);" +
--- a/app/qml/TerminalFrame.qml
+++ b/app/qml/TerminalFrame.qml
@@ -22,13 +22,13 @@ import QtQuick 2.0
 import "utils.js" as Utils

 ShaderEffect {
-    property color _frameColor: appSettings.frameColor
+    property color _staticFrameColor: "#fff"
    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(_frameColor, _lightColor, _ambientLight)
+    property color frameColor: Utils.mix(_staticFrameColor, _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 = clamp(sqrt(frameShadow), 0.0, 1.0);
+            frameShadow = max(sqrt(frameShadow), 0.0);
            color *= frameShadow;
            alpha = sum2(1.0 - step(vec2(0.0), coords) + step(vec2(1.0), coords));
            alpha = clamp(alpha, 0.0, 1.0);
--- a/packaging/appdata/cool-retro-term.appdata.xml
+++ b/packaging/appdata/cool-retro-term.appdata.xml
@@ -16,11 +16,11 @@
  <screenshots>
    <screenshot type="default">
      <caption>Default amber look</caption>
-      <image width="1022" height="791">https://i.imgur.com/NUfvnlu.png</image>
+      <image width="1022" height="791">https://camo.githubusercontent.com/2443e662e95733ba6ae331f391f6ec036d1ee7fd/687474703a2f2f692e696d6775722e636f6d2f4e5566766e6c752e706e67</image>
    </screenshot>
    <screenshot>
      <caption>Apple II look</caption>
-      <image width="1024" height="796">https://i.imgur.com/MMmM6Ht.png</image>
+      <image width="1024" height="796">https://camo.githubusercontent.com/44a19842d532555c7b02bf6b4b4684add9edf18c/687474703a2f2f692e696d6775722e636f6d2f4d4d6d4d3648742e706e67</image>
    </screenshot>
  </screenshots>