Installation Guide

VioletWing can be installed in two main ways: by cloning the repository for developers or downloading a pre-built executable for quick use. This guide provides detailed steps, including dependencies and potential pitfalls.

Written By Jesewe

System Requirements

  • Operating System: Windows (recommended for full compatibility; other OS may require adjustments).

  • Python Version: Python >= 3.8 and < 3.12.5. If you don't have Python installed, download it from the official website (python.org) and ensure it's added to your PATH.

  • Hardware: A modern CPU/GPU for smooth performance in Counter-Strike 2. At least 8GB RAM recommended.

  • Game: Counter-Strike 2 must be installed and runnable.

  • Internet: Required for initial offset fetching and updates.

Option 1: Clone the Repository (For Developers)

  1. Install Git: If not already installed, download Git from git-scm.com and install it.

  2. Clone the Repository:

  3. Install Dependencies:

    • Ensure pip is up to date: python -m pip install --upgrade pip

    • Install from requirements.txt: pip install -r requirements.txt

    • Special Note on PyMeow: This library is crucial for the Overlay feature.

      • Visit the PyMeow GitHub releases: https://github.com/qb-0/pyMeow/releases

      • Download the latest pyMeow*.zip file (e.g., pyMeow-1.73.42.zip).

      • Install it: pip install path/to/pyMeow*.zip (replace with actual path).

      • If you encounter errors like "wheel not supported," ensure your Python version matches the wheel's architecture (32/64-bit).

  4. Compile the Project (Optional):

    • If you want a standalone executable, run compile.bat (Windows only).

    • This uses PyInstaller to bundle everything into VioletWing.exe.

    • Common issues: If PyInstaller is not found, install it via pip install pyinstaller.

    • Output will be in the dist folder.

  5. Verify Installation:

    • Run python main.py to test.

    • Check the console for errors; logs will be in %LOCALAPPDATA%\Requests\ItsJesewe\crashes\.

Option 2: Download Pre-Built Executable (Quick Start)

  1. Download from Releases:

  2. Run the Executable:

    • Double-click VioletWing.exe.

    • If Windows Defender flags it, allow it (it's open-source; you can verify the code).

After installation, proceed to "Running VioletWing for the First Time" for setup.