Merge pull request #9 from T1ckbase/8-hud-rainbow-sync

8 hud rainbow sync

Author: T1ckbase

.editorconfig

@@ -6,4 +6,4 @@ insert_final_newline = true
 end_of_line = lf
 indent_style = space
 indent_size = 2
-max_line_length = 160
+max_line_length = 120

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/release.yaml

@@ -15,15 +15,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
-          fetch-depth: 0 # Required for git describe to work correctly
+          fetch-depth: 0
 
       - name: Setup Bun
         uses: oven-sh/setup-bun@v2
         with:
           bun-version: latest
 
       - name: Install dependencies
-        run: bun install
+        run: bun install --frozen-lockfile
 
       - name: Build
         run: bun run build
@@ -34,4 +34,5 @@ jobs:
       - name: Create Draft Release
         env:
           GH_TOKEN: ${{ github.token }}
-        run: gh release create ${{ github.ref_name }} --draft --generate-notes --verify-tag cfg.zip
+          TAG_NAME: ${{ github.ref_name }}
+        run: gh release create "$TAG_NAME" --draft --generate-notes --verify-tag cfg.zip

README.md

@@ -15,7 +15,8 @@
 
 ## Features
 
-- **Changes color based on mouse movement**
+- **Changes the crosshair color based on mouse movement**
+- **Can sync the HUD color with the crosshair**
 - **Supports multiple color palettes**
 - **Allows adjustable speed**
 
@@ -30,55 +31,37 @@
 
 ## Usage
 
-1. Place the `t1ckbase_rainbow_crosshair` folder into: `Steam/steamapps/common/Counter-Strike Global Offensive/game/csgo/cfg`
+1. Place the `t1ckbase_rainbow_crosshair` folder in: `Steam/steamapps/common/Counter-Strike Global Offensive/game/csgo/cfg`
 2. Add the following commands to your `autoexec.cfg`
 
 ```
 exec t1ckbase_rainbow_crosshair/init
 
-// Load color palette
-rainbow_crosshair_load_oklch
-// rainbow_crosshair_load_hsl
+rainbow_crosshair_load_hsl
+// rainbow_crosshair_load_oklch
 
-// Set color change speed [1-30]
 rainbow_crosshair_speed_10
 
-rainbow_crosshair_enable
-// rainbow_crosshair_disable
+// rainbow_crosshair_hud_sync_on
+rainbow_crosshair_hud_sync_off
+
+rainbow_crosshair_on
+// rainbow_crosshair_off
 // rainbow_crosshair_toggle
 ```
 
 ## Aliases
 
-- Enable rainbow crosshair
-
-```
-rainbow_crosshair_enable
-```
-
-- Disable rainbow crosshair
-
-```
-rainbow_crosshair_disable
-```
-
-- Toggle rainbow crosshair
-
-```
-rainbow_crosshair_toggle
-```
-
-- Load color palette (`oklch`, `hsl`)
-
-```
-rainbow_crosshair_load_oklch
-```
-
-- Adjust speed `[1-30]`
-
-```
-rainbow_crosshair_speed_10
-```
+| Command                                                     | Description                                  |
+| ----------------------------------------------------------- | -------------------------------------------- |
+| `rainbow_crosshair_on`                                      | Turn the rainbow crosshair on.               |
+| `rainbow_crosshair_off`                                     | Turn the rainbow crosshair off.              |
+| `rainbow_crosshair_toggle`                                  | Toggle the rainbow crosshair on or off.      |
+| `rainbow_crosshair_hud_sync_on`                             | Sync the HUD color with the crosshair color. |
+| `rainbow_crosshair_hud_sync_off`                            | Stop syncing the HUD color.                  |
+| `rainbow_crosshair_load_hsl`                                | Load the `hsl` palette.                      |
+| `rainbow_crosshair_load_oklch`                              | Load the `oklch` palette.                    |
+| `rainbow_crosshair_speed_1` to `rainbow_crosshair_speed_30` | Set the color change speed.                  |
 
 ## Color palettes preview
 
@@ -89,4 +72,4 @@ rainbow_crosshair_speed_10
 
 <br/>
 
-![cs2-rainbow-crosshair](https://github.com/T1ckbase/cs2-rainbow-crosshair/assets/146760065/6a01bc8a-d4c8-48ad-b6ed-f93c4a2c1b64)
+[Watch the CS2 rainbow crosshair preview](https://github.com/user-attachments/assets/0f0c74d4-9cc3-4000-8a3c-e960f30d1234)