add gitignore for PyCharm

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  push:
+    branches-ignore:
+      - main
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff
+    - name: Analysing the code with ruff
+      run: |
+        ruff check .

.github/workflows/windows-build-release.yml

@@ -0,0 +1,69 @@
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: write
+
+jobs:
+
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff
+    - name: Analysing the code with ruff
+      run: |
+        ruff check .
+
+  # The build job runs on a Windows machine and performs various build steps.
+  build:
+    runs-on: windows-latest
+    needs: check
+    steps:    
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Freeze Installer
+      run: |
+        pyinstaller build.spec 
+    - name: Build Installer
+      run: |
+        iscc installer.iss
+    - name: Freeze Portable
+      run: |
+        pyinstaller --distpath dist-portable build-portable.spec
+
+    - name: Zip Portable 
+      shell: pwsh
+      run: |
+        Copy-Item -Path assets -Destination dist-portable\ -Recurse
+        Copy-Item -Path configs -Destination dist-portable\ -Recurse
+        Compress-Archive -Path dist-portable -DestinationPath Grimassist-Portable-${{github.ref_name}}.zip
+
+    - name: release
+      uses: softprops/action-gh-release@v1
+      with:
+        files: |
+          Output/Grimassist-Installer-${{github.ref_name}}.exe
+          Grimassist-Portable-${{github.ref_name}}.zip
+        tag_name: ${{github.ref_name}}
+        draft: false
+        prerelease: false

.gitignore

@@ -74,6 +74,12 @@ docs/_build/
 # PyBuilder
 target/
 
+# VsCode
+.vscode/
+
+# PyCharm
+.idea/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 
@@ -129,3 +135,10 @@ dmypy.json
 .pyre/
 *.bat
 log.txt
+
+# Ruff
+.ruff/
+.ruff_cache/
+
+# Output directory
+output/

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Code Reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+## Community Guidelines
+
+Be a decent human being, bot, or whatever.

README.md

@@ -1,12 +1,21 @@
-# Project Gameface
-Project Gameface helps gamers control their mouse cursor using their head movement and facial gestures.
+# Grimassist
+Grimassist helps gamers control their mouse cursor using their head movement and facial gestures.
 
 
 
-# Download
+# Download 
+
+## Single portable directory
+
 1. Download the program from [Release section](../../releases/)
-2. Run `run_app.exe`
+2. Run `grimassist.exe`
+
+
+## Installer 
 
+1. Download the Grimassist-Installer.exe from [Release section](../../releases/)
+2. Install it 
+3. Run from your Windows shortcuts/desktop
 
 
 # Model used
@@ -31,15 +40,15 @@ MediaPipe Face Landmark Detection API [Task Guide](https://developers.google.com
 ## Installation
 > Environment
 >- Windows  
->- Python 3.9
+>- Python 3.10
 ```
 pip install -r requirements.txt
 ```
 
 ## Quick start
 1. Run main application
     ```
-    python run_app.py
+    python grimassist.py
     ```
 
 
@@ -52,20 +61,22 @@ pip install -r requirements.txt
 |-----------|---------------------------------------|
 | camera_id | Default camera index on your machine. |
 | tracking_vert_idxs | Tracking points for controlling cursor ([see](assets/images/uv_unwrap_full.png)) |
-| camera_id | Default camera index on your machine. |
 | spd_up    | Cursor speed in the upward direction  |
 | spd_down  | Cursor speed in downward direction    |
 | spd_left  | Cursor speed in left direction        |
 | spd_right | Cursor speed in right direction       |
-| pointer_smooth  | Amount of cursor smoothness           |
-| shape_smooth  | Reduces the flickering of the action           |
-| hold_trigger_ms  | Hold action trigger delay in milliseconds           |
-| auto_play  | Automatically begin playing when you launch the program           |
-| mouse_acceleration  | Make the cursor move faster when the head moves quickly        |
-| use_transformation_matrix  | Control cursor using head direction (tracking_vert_idxs will be ignored)   |
+| pointer_smooth | Amount of cursor smoothness           |
+| shape_smooth | Reduces the flickering of the action  |
+| tick_interval_ms | interval between each tick of the pipeline in milliseconds |
+| hold_trigger_ms | Hold action trigger delay in milliseconds |
+| rapid_fire_interval_ms | interval between each activation of the action in milliseconds |
+| auto_play | Automatically begin playing when you launch the program |
+| enable    | Enable cursor control                 |
+| mouse_acceleration | Make the cursor move faster when the head moves quickly |
+| use_transformation_matrix | Control cursor using head direction (tracking_vert_idxs will be ignored) |
 
 
-## Keybinds configs
+## Keybinding configs
 >[mouse_bindings.json](configs/default/mouse_bindings.json)  
 >[keyboard_bindings.json](configs/default/keyboard_bindings.json) 
 
@@ -75,20 +86,30 @@ gesture_name: [device_name, action_name, threshold, trigger_type]
 ```
 
 
-|              |                                                                                           |
-|--------------|-------------------------------------------------------------------------------------------|
-| gesture_name | Face expression name, see the [list](src/shape_list.py#L16)       |
-| device_name  | "mouse" or "keyboard"                                                                     |
-| action_name  | "left", "right" and "middle" for mouse. "" for keyboard, for instance, "w" for the W key. |
-| threshold    | The action trigger threshold has values ranging from 0.0 to 1.0.        |
-| trigger_type | Action trigger type, use "single" for a single trigger, "hold" for ongoing action.                                 |
+|              |                                                                                                                                                                                                                                                                                                                                                                                       |
+|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| gesture_name | Face expression name, see the [list](src/shape_list.py#L16)                                                                                                                                                                                                                                                                                                                           |
+| device_name  | "meta", "mouse", or "keyboard"                                                                                                                                                                                                                                                                                                                                                        |
+| action_name  | name of the action e.g. "left" for mouse. <br/>e.g. "ctrl" for keyboard<br/> e.g. "pause" for meta                                                                                                                                                                                                                                                                                    |
+| threshold    | The action trigger threshold has values ranging from 0.0 to 1.0.                                                                                                                                                                                                                                                                                                                      |
+| trigger_type | "single" for a single trigger<br/> "hold" for ongoing action. <br/> "dynamic" for a mixture of single and hold. It first acts like single and after passing the amount of miliseconds from hold_trigger_ms like hold. Note: this is the default behaviour for mouse buttons<br/> "toggle" to switch an action on and off<br/>"rapid" trigger an action every "rapid_fire_interval_ms" |
 
 
 
 
 
 # Build
+
+## Pyinstaller / Frozen app
 ```
     pyinstaller build.spec
 ```
 
+# Build Installer
+
+1. Install [inno6](https://jrsoftware.org/isdl.php#stable)
+2. Build using the `installer.iss` file  
+
+# Attribution
+Blink graphics in the user interface are based on
+[Eye icons created by Kiranshastry - Flaticon](https://www.flaticon.com/free-icons/eye).

assets/themes/google_theme.json

@@ -48,7 +48,7 @@
       "corner_radius": 500,
       "border_width": 0,
       "button_length": 0,
-      "fg_Color": ["#444746", "#4A4D50"],
+      "fg_color": ["#444746", "#4A4D50"],
       "progress_color": ["#64DD17", "#1f538d"],
       "button_color": ["#8F8F8F", "#D5D9DE"],
       "button_hover_color": ["gray20", "gray100"],