chore: remove KROSSHAIR_SCALE, clean up README and install messages

Drop the KROSSHAIR_SCALE env var (hardcode scale to 1). Rewrite README
to focus on crosshair-maker integration, remove nixos/requirements
sections, and update AUR install messages to match.

Author: noahlyk

.github/workflows/release.yml

@@ -5,49 +5,58 @@ on:
     branches: [main]
 
 jobs:
+  check-skip:
+    runs-on: ubuntu-latest
+    outputs:
+      should_skip: ${{ steps.check.outputs.skip }}
+    steps:
+      - name: Check if this is a version bump commit
+        id: check
+        run: |
+          MSG="${{ github.event.head_commit.message }}"
+          if echo "$MSG" | grep -q "^chore: bump version"; then
+            echo "skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "skip=false" >> $GITHUB_OUTPUT
+          fi
+
   version:
+    needs: [check-skip]
+    if: needs.check-skip.outputs.should_skip == 'false'
     runs-on: ubuntu-latest
     outputs:
       new_version: ${{ steps.bump.outputs.new_version }}
+      old_version: ${{ steps.bump.outputs.old_version }}
     steps:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - name: Install tools
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y python python-pip
-          pip install --user bumpver
-      - name: Calculate version bump
+      - name: Determine version bump
         id: bump
         run: |
-          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
-          if [ -n "$LAST_TAG" ]; then
-            COMMITS=$(git log $LAST_TAG..HEAD --pretty=%s)
-          else
-            COMMITS=$(git log HEAD --pretty=%s)
+          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+          OLD_VERSION=${LAST_TAG#v}
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$OLD_VERSION"
+
+          COMMITS=$(git log ${LAST_TAG}..HEAD --pretty=%s 2>/dev/null || git log HEAD --pretty=%s)
+
+          if echo "$COMMITS" | grep -q "^feat:"; then
+            MINOR=$((MINOR + 1))
+            PATCH=0
+          elif echo "$COMMITS" | grep -q "^chore:\|^fix:\|^docs:"; then
+            PATCH=$((PATCH + 1))
           fi
+
           if echo "$COMMITS" | grep -q "^BREAKING CHANGE:"; then
-            bumpver update --major
-          elif echo "$COMMITS" | grep -q "^feat:"; then
-            bumpver update --minor
-          else
-            bumpver update --patch
+            MAJOR=$((MAJOR + 1))
+            MINOR=0
+            PATCH=0
           fi
-          NEW_VERSION=$(bumpver show | grep -E "^[0-9]+\.[0-9]+\.[0-9]+" | head -1)
+
+          NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
           echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
-      - name: Bump PKGBUILD versions
-        run: |
-          sed -i "s/pkgver=.*/pkgver=${{ steps.bump.outputs.new_version }}/" PKGBUILD
-          sed -i "s/pkgver=.*/pkgver=${{ steps.bump.outputs.new_version }}/" aur/PKGBUILD
-          cd aur && makepkg --printsrcinfo > .SRCINFO
-      - name: Upload version files (uncommitted)
-        uses: actions/upload-artifact@v6
-        with:
-          name: version-files
-          path: |
-            PKGBUILD
-            aur/
+          echo "old_version=$OLD_VERSION" >> $GITHUB_OUTPUT
+          echo "Bumping $OLD_VERSION -> $NEW_VERSION"
 
   build:
     needs: [version]
@@ -56,10 +65,6 @@ jobs:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - uses: actions/download-artifact@v7
-        with:
-          name: version-files
-          path: .
       - name: Install system dependencies
         run: |
           sudo apt-get update
@@ -76,90 +81,130 @@ jobs:
           elif [ "$ARCH" = "aarch64" ]; then
             echo "arch_name=aarch64" >> $GITHUB_OUTPUT
           fi
+      - name: Update PKGBUILD versions
+        run: |
+          VERSION=${{ needs.version.outputs.new_version }}
+          sed -i "s/pkgver=.*/pkgver=$VERSION/" PKGBUILD
+          sed -i "s/pkgver=.*/pkgver=$VERSION/" aur/PKGBUILD
       - name: Create tarball
         run: |
-          mkdir -p krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}
-          cp lib/krosshair.so krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}/
-          cp krosshair.json krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}/
-          cp LICENSE krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}/ 2>/dev/null || true
-          tar -czf krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}.tar.gz -C krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }} .
-      - name: Generate checksum
-        run: sha256sum krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}.tar.gz > krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}.sha256
-      - name: Upload artifacts
+          ARCH_NAME=${{ steps.arch.outputs.arch_name }}
+          VERSION=${{ needs.version.outputs.new_version }}
+          mkdir -p krosshair-linux-${ARCH_NAME}
+          cp lib/krosshair.so krosshair-linux-${ARCH_NAME}/
+          cp krosshair.json krosshair-linux-${ARCH_NAME}/
+          cp LICENSE krosshair-linux-${ARCH_NAME}/ 2>/dev/null || true
+          tar -czf krosshair-linux-${ARCH_NAME}.tar.gz -C krosshair-linux-${ARCH_NAME} .
+          sha256sum krosshair-linux-${ARCH_NAME}.tar.gz > krosshair-linux-${ARCH_NAME}.sha256
+      - name: Upload build artifacts
         uses: actions/upload-artifact@v6
         with:
-          name: krosshair-${{ needs.version.outputs.new_version }}-${{ steps.arch.outputs.arch_name }}
+          name: build-output
           path: |
-            krosshair-*.tar.gz
-            krosshair-*.sha256
+            PKGBUILD
+            aur/
+            krosshair-linux-*.tar.gz
+            krosshair-linux-*.sha256
 
-  commit-and-release:
+  release:
     needs: [version, build]
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v5
         with:
           ref: main
           fetch-depth: 0
       - uses: actions/download-artifact@v7
         with:
-          path: artifacts
-      - name: Restore version files from successful build
-        run: |
-          mkdir -p aur
-          cp artifacts/version-files/PKGBUILD .
-          cp -r artifacts/version-files/aur/* aur/
-      - name: Commit version bump and create tag
+          name: build-output
+          path: .
+      - name: Configure git
         run: |
           git config user.name "GitHub Action"
           git config user.email "action@github.com"
-          git add PKGBUILD aur/
-          git commit -m "chore: bump version to v${{ needs.version.outputs.new_version }}" || echo "No changes to commit"
-          git tag "v${{ needs.version.outputs.new_version }}" -f
-          git push origin main
-          git push origin "v${{ needs.version.outputs.new_version }}" -f
+          gh auth setup-git
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Push to AUR
+      - name: Commit version bump and tag
         run: |
-          mkdir -p ~/.ssh
-          echo "$AUR_SSH_KEY" > ~/.ssh/aur
-          chmod 600 ~/.ssh/aur
-          ssh-keyscan aur.archlinux.org >> ~/.ssh/known_hosts
-          rm -rf aur
-          if git clone ssh://aur@aur.archlinux.org/krosshair.git aur 2>&1; then
-            echo "Cloned existing AUR repo"
-            cp -r artifacts/version-files/aur/* aur/
-            cd aur
-          else
-            echo "Creating new AUR repo"
-            mkdir aur
-            cp -r artifacts/version-files/aur/* aur/
-            cd aur
-            git init
-            git remote add origin ssh://aur@aur.archlinux.org/krosshair.git
-          fi
-          makepkg --printsrcinfo > .SRCINFO
-          git config user.name "GitHub Action"
-          git config user.email "action@github.com"
-          git add PKGBUILD .SRCINFO krosshair.install
-          git commit -m "Update to v${{ needs.version.outputs.new_version }}" || echo "No changes to commit"
-          git push origin master
+          VERSION=${{ needs.version.outputs.new_version }}
+          git add PKGBUILD aur/
+          git commit -m "chore: bump version to v${VERSION}" || echo "No changes to commit"
+          git tag "v${VERSION}" -f
+          git push origin main
+          git push origin "v${VERSION}" -f
         env:
-          AUR_SSH_KEY: ${{ secrets.AUR_SSH_KEY }}
-      - name: Create release with assets
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create GitHub release
         run: |
-          ARCH=$(uname -m)
-          if [ "$ARCH" = "x86_64" ]; then
+          VERSION=${{ needs.version.outputs.new_version }}
+          ARCH_NAME=$(uname -m)
+          if [ "$ARCH_NAME" = "x86_64" ]; then
             ARCH_NAME="x86_64"
-          elif [ "$ARCH" = "aarch64" ]; then
+          elif [ "$ARCH_NAME" = "aarch64" ]; then
             ARCH_NAME="aarch64"
           fi
-          gh release delete "v${{ needs.version.outputs.new_version }}" --yes 2>/dev/null || true
-          gh release create "v${{ needs.version.outputs.new_version }}" \
-            --title "v${{ needs.version.outputs.new_version }}" \
-            --notes "Release v${{ needs.version.outputs.new_version }}" \
-            artifacts/krosshair-${{ needs.version.outputs.new_version }}-${ARCH_NAME}/krosshair-${{ needs.version.outputs.new_version }}-${ARCH_NAME}.tar.gz \
-            artifacts/krosshair-${{ needs.version.outputs.new_version }}-${ARCH_NAME}/krosshair-${{ needs.version.outputs.new_version }}-${ARCH_NAME}.sha256
+          gh release delete "v${VERSION}" --yes 2>/dev/null || true
+          gh release create "v${VERSION}" \
+            --title "v${VERSION}" \
+            --notes "Release v${VERSION}" \
+            krosshair-linux-${ARCH_NAME}.tar.gz \
+            krosshair-linux-${ARCH_NAME}.sha256
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  aur:
+    needs: [version, build, release]
+    runs-on: ubuntu-latest
+    container: archlinux:latest
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: build-output
+          path: .
+      - name: Push to AUR
+        run: |
+          VERSION=${{ needs.version.outputs.new_version }}
+          pacman -Sy --noconfirm openssh git sudo
+
+          useradd -m builduser
+          echo "builduser ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+
+          mkdir -p /home/builduser/.ssh
+          echo "$AUR_SSH_KEY" > /home/builduser/.ssh/aur
+          chmod 600 /home/builduser/.ssh/aur
+          chmod 700 /home/builduser/.ssh
+          chown -R builduser:builduser /home/builduser/.ssh
+          ssh-keyscan aur.archlinux.org >> /home/builduser/.ssh/known_hosts
+
+          cp -r aur /home/builduser/aur
+          chown -R builduser:builduser /home/builduser/aur
+
+          sudo -u builduser VERSION="$VERSION" bash -c '
+            cd /home/builduser
+            if git clone ssh://aur@aur.archlinux.org/krosshair.git aur-push 2>&1; then
+              echo "Cloned existing AUR repo"
+            else
+              echo "Creating new AUR repo"
+              mkdir -p aur-push
+              cd aur-push
+              git init
+              git remote add origin ssh://aur@aur.archlinux.org/krosshair.git
+              cd ..
+            fi
+
+            cp aur/PKGBUILD aur-push/
+            cp aur/krosshair.install aur-push/
+
+            cd aur-push
+            makepkg --printsrcinfo > .SRCINFO
+            git config user.name "GitHub Action"
+            git config user.email "action@github.com"
+            git add PKGBUILD .SRCINFO krosshair.install
+            git commit -m "Update to v${VERSION}" || echo "No changes to commit"
+            GIT_SSH_COMMAND="ssh -i /home/builduser/.ssh/aur -o StrictHostKeyChecking=no" git push origin master
+          '
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          AUR_SSH_KEY: ${{ secrets.AUR_SSH_KEY }}

README.md

@@ -5,27 +5,39 @@ A crosshair overlay for games on linux using vulkan.
 ![quake](img/quake-crosshair.png)
 
 ## Installation
-`make && make install`
 
-On nixos-unstable: Add `krosshair` (or clone and add `(callPackage <local krosshair repo path>/derivation.nix { })`) to packages and `nixos-rebuild switch`.
+### AUR
+
+```bash
+yay -S krosshair
+```
+
+### From source
+
+```bash
+git clone https://github.com/fibsussy/krosshair.git
+cd krosshair
+make
+```
 
 ## Usage
-Simply start the your game with `KROSSHAIR=1` set. When using steam, put `KROSSHAIR=1 %command%` into the launch options of your game. Additionally you can use the following variables to customize your crosshair.
-- `KROSSHAIR_IMG=/path/to/crosshair-image.png` (i've provided some crosshairs in [here](https://github.com/krob64/krosshair/tree/main/crosshairs), copy them wherever you like)
-    - alternatively you can use a [crosshair generator site](https://crosshair.themeta.gg/) (or [this one](https://guywiddacaptain.github.io/aimX/))
+
+```bash
+export KROSSHAIR=1
+your-game
+```
+
+For Steam games, add `KROSSHAIR=1 %command%` to launch options.
+
 ## crosshair-maker integration
 
-If you have [crosshair-maker](https://github.com/fibsussy/crosshair-maker) installed, krosshair automatically uses your currently selected crosshair — no configuration needed. The currently active project's exported PNG (`~/.config/crosshair-maker/projects/current.png`) is loaded as the overlay. You can still override this with `KROSSHAIR_IMG` if you want.
+krosshair works out of the box with [crosshair-maker](https://github.com/fibsussy/crosshair-maker), a crosshair overlay creator with SVG rendering and preview. The currently selected crosshair is automatically exported to `~/.config/crosshair-maker/projects/current.png`, which krosshair picks up as its default — just launch your game with `export KROSSHAIR=1` and go.
 
-- `KROSSHAIR_SCALE=1.0` (scaling the scrosshair may make it look blurry, i'd suggest to just create a bigger/smaller crosshair)
+You can override the image with `export KROSSHAIR_IMG=/path/to/crosshair.png` if you want to use a custom file.
 
 ## Can i get banned for this?
 I don't know, use at your own risk. I've only used it in Quake Champions and STRAFTAT, both of which don't really have an anticheat.
 
-## Setting up requirements
-Needs Vulkan libs to build.
-All requirements can be set up with `nix-shell' when nix is installed.
-
 ## Issues
 As of now, the overlay leaks a bit of memory everytime you alt-tab out of/into the game, as well as everytime the window is being resized and upon resolution changes. It's not a big leak and shouldn't cause any problems, but it's still worth noting.
 I've tried fixing it multiple times but have always hit a dead-end. If someone more experienced with vulkan wants to help, take a look at [this issue](https://github.com/krob64/krosshair/issues/1). I know it's a bit of a mess, this whole project is based on a morally questionable apex legends project which i'm unsure if i should link to it here, coupled with me jumping into it right after completing the vulkan tutorial.

aur/krosshair.install

@@ -4,20 +4,17 @@ post_install() {
     echo ""
     echo "==> Getting Started:"
     echo ""
-    echo "    1. Run your game with KROSSHAIR=1 set"
-    echo "       Example: KROSSHAIR=1 your-game"
+    echo "    KROSSHAIR=1 your-game"
     echo ""
-    echo "    2. For Steam games, add to launch options:"
-    echo "       KROSSHAIR=1 %command%"
+    echo "    For Steam games, add to launch options:"
+    echo "    KROSSHAIR=1 %command%"
     echo ""
-    echo "==> Customization:"
-    echo "       KROSSHAIR_IMG=/path/to/crosshair.png"
-    echo "       KROSSHAIR_SCALE=1.0"
+    echo "==> crosshair-maker integration:"
+    echo "    If crosshair-maker is installed, your currently selected"
+    echo "    crosshair is used automatically. Override with:"
+    echo "    export KROSSHAIR_IMG=/path/to/crosshair.png"
     echo ""
-    echo "==> Sample crosshairs installed at:"
-    echo "       /usr/share/krosshair/crosshairs/"
-    echo ""
-    echo "==> For more info: https://github.com/fibsussy/krosshair"
+    echo "==> For more info: https://github.com/krob64/krosshair"
     echo ""
 }
 

src/layer.c

@@ -962,26 +962,8 @@ static void ensure_swapchain_crosshair(swapchain_data_t* data,
                     &data->crosshair_upload_buffer_mem, data->crosshair_image);
         }
 
-        float scale           = 1;
-        const char* scale_str = getenv("KROSSHAIR_SCALE");
-        if (scale_str) {
-                char* end = NULL;
-                for (float scale_cvt = strtof(scale_str, &end); scale_str != end;
-                     scale_cvt = strtof(scale_str, &end)) {
-                        printf("got scale: %f\n", scale_cvt);
-                        scale = scale_cvt; 
-                        scale_str = end;
-                        if (errno == ERANGE) {
-                                printf("KROSSHAIR_SCALE invalid.\n");
-                                scale = 1;
-                        }
-                }
-        }
-
-        printf("scale: %f\n", scale);
-
         setup_vertices((float)data->width, (float)data->height,
-                       (float)tex_height, (float)tex_width, scale);
+                       (float)tex_height, (float)tex_width, 1.0f);
 
         data->crosshair_uploaded = 1;
 }