Merge branch 'main' of https://github.com/noisecode3/TombRaiderLinuxL…

…auncher

.github/workflows/codacy.yml

@@ -0,0 +1,61 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow checks out code, performs a Codacy security scan
+# and integrates the results with the
+# GitHub Advanced Security code scanning feature.  For more information on
+# the Codacy security scan action usage and parameters, see
+# https://github.com/codacy/codacy-analysis-cli-action.
+# For more information on Codacy Analysis CLI in general, see
+# https://github.com/codacy/codacy-analysis-cli.
+
+name: Codacy Security Scan
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '43 3 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  codacy-security-scan:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: Codacy Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
+      - name: Run Codacy Analysis CLI
+        uses: codacy/codacy-analysis-cli-action@d840f886c4bd4edc059706d09c6a1586111c540b
+        with:
+          # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
+          # You can also omit the token and run the tools that support default configurations
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          verbose: true
+          output: results.sarif
+          format: sarif
+          # Adjust severity of non-security issues
+          gh-code-scanning-compat: true
+          # Force 0 exit code to allow SARIF file generation
+          # This will handover control about PR rejection to the GitHub side
+          max-allowed-issues: 2147483647
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif

README.md

@@ -4,22 +4,20 @@ A tool to run Tomb Raider classics 1, 2, 3, 4, 5 on Linux with Wine/Proton. Prob
 This application will be written in c++ for the GUI and for modding and manipulation configuration files. Bash for launching with Steam or Lutris or just Wine.
 
 # Features
-
-- with steam or Lutris to select a map from trle.net to play
-- launch along the game a controller mapper like qjoypad or antimicrox
-- script so that I dont have to manually move all game files when I want to play a mod with steam input to steams tomb raider game folder
-- backup game savefiles and configurations for all maps and moods.
-- check for corrupted config.txt file and possible other workarounds. (TR3)
-- check if I forgot to connect controller and so on... On Linux. I like my Steam controller configurations also.
-- implement patching of files and backup.
-- checksums
-- download maps/mods, and install them
+* with steam or Lutris to select a map from trle.net to play
+* launch along the game a controller mapper like qjoypad or antimicrox
+* script so that I dont have to manually move all game files when I want to play a mod with steam input to steams tomb raider game folder
+* backup game savefiles and configurations for all maps and moods.
+* check for corrupted config.txt file and possible other workarounds. (TR3)
+* check if I forgot to connect controller and so on... On Linux. I like my Steam controller configurations also.
+* implement patching of files and backup.
+* checksums
+* download maps/mods, and install them
 
 # trle.net mods the launcher will download and play with wine-tkg that I tested
-
-- [Calypsis Jungle - Part One](https://www.trle.net/sc/levelfeatures.php?lid=3500)
-- [Feder - Templars Secret](https://www.trle.net/sc/levelfeatures.php?lid=3082)
-- [Delca - Kitten Adventure](https://www.trle.net/sc/levelfeatures.php?lid=3379)
+* [Calypsis Jungle - Part One](https://www.trle.net/sc/levelfeatures.php?lid=3500)
+* [Feder - Templars Secret](https://www.trle.net/sc/levelfeatures.php?lid=3082)
+* [Delca - Kitten Adventure](https://www.trle.net/sc/levelfeatures.php?lid=3379)
 
 # Guide
 
@@ -33,31 +31,26 @@ It's a bit demanding on the memory, try use gallium nine if you have nouveau
 No special graphics card, but if you gonna play mods you could need
 One 2010+ card that has about 2-4 Gb for some Tomb Raider 4 mods with enhanced graphics
 recommend patches, on steam proton 7
-
-- https://github.com/Trxyebeep/tomb3
-
-- https://github.com/dege-diosg/dgVoodoo2
-
-- https://tombraiders.net/stella/downloads/widescreen.html
-
-- https://core-design.com/community_tr3withoutcrystals.html
+* https://github.com/Trxyebeep/tomb3
+* https://github.com/dege-diosg/dgVoodoo2
+* https://tombraiders.net/stella/downloads/widescreen.html
+* https://core-design.com/community_tr3withoutcrystals.html
 
 ## TR3
-
 Most, if not all trle.net tr3 mods will work with proton 7, if unpacked and configured with dgVoodoo2
 some new tr3 mods already comes with the tomb3 patch. A combination of tomb3 and dgVoodoo2 is recommended for the original game.
 
 # Tips
 ## Recommended compatibility layer
-- Proton 7.0 for TR3 - with dgVoodoo2
-- Proton 5.0-10 for TR3
-- Sometimes avoiding Ctrl and Alt will make wine/proton
-- [GloriousEggroll](https://github.com/GloriousEggroll/proton-ge-custom/releases/tag/6.21-GE-2)
-- [Wine-tkg](https://github.com/Frogging-Family/wine-tkg-git/releases/tag/7.6.r12.g51472395) tick "emulate a virtual desktop"
+* Proton 7.0 for TR3 - with dgVoodoo2
+* Proton 5.0-10 for TR3
+* Sometimes avoiding Ctrl and Alt will make wine/proton
+* [GloriousEggroll](https://github.com/GloriousEggroll/proton-ge-custom/releases/tag/6.21-GE-2)
+* [Wine-tkg](https://github.com/Frogging-Family/wine-tkg-git/releases/tag/7.6.r12.g51472395) tick "emulate a virtual desktop"
 
 ## Recommended compatibility layer configuration and other tips
 ### TR3
-- Use fsync or esync
-- If you have problems witn FMV cut-scenes. Run winecfg go to graphics tab and tick "emulate a virtual desktop" use same size as you're desktop under. Or use dgVoodoo2
-- Sometimes when you run tomb3.exe -setup you window manager will put the background over the configuration windows, for example in i3 mod+f "full screen key" or something similar like alt+tab could help you see the window
-- The game will recognize you're controller, left stick only, see https://github.com/AntiMicroX/antimicrox
+* Use fsync or esync
+* If you have problems witn FMV cut-scenes. Run winecfg go to graphics tab and tick "emulate a virtual desktop" use same size as you're desktop under. Or use dgVoodoo2
+* Sometimes when you run tomb3.exe -setup you window manager will put the background over the configuration windows, for example in i3 mod+f "full screen key" or something similar like alt+tab could help you see the window
+* The game will recognize your controller, left stick only, see [https://github.com/AntiMicroX/antimicrox](https://github.com/AntiMicroX/antimicrox)