Skip to content

Install

LinJHS edited this page Jan 4, 2025 · 2 revisions

Installing from a Release Package

The easiest way to get started with AntiRec is by installing it from a pre-built release package.

  1. Download the Latest Release

    Visit the Releases page and download the latest .exe/.msi installer for Windows.

  2. Run the Installer

    Once downloaded, locate the installer file and double-click it to start the installation process. Follow the on-screen instructions to complete the installation. The installer will set up everything needed to run AntiRec on your system.

  3. Install a virtual sound card driver

    Install a virtual sound card driver such as "Virtual Audio Cable" on your system

  4. Launch the Application

    After installation, you can launch AntiRec.

Running Directly from Source

If you are a developer and wish to contribute to the project or customize it for your needs, you can run the application directly from the source code. Please follow these steps:

Prerequisites

Before you begin, ensure that your system meets the following prerequisites:

  • Windows 10 or later.
  • Git installed and configured on your machine.
  • Node.js (with npm or pnpm) installed. We recommend using pnpm for dependency management in this project.
  • Rust and Cargo installed as they are required by Tauri.
  • A virtual sound card driver such as "Virtual Audio Cable"

You can download and install these tools from their official websites if necessary.

Steps

  1. Clone the Repository

    Open Command Prompt or PowerShell and clone the repository with the following command:

    git clone https://github.com/LinJHS/AntiRec.git
    cd AntiRec
  2. Install Dependencies

    Ensure you are in the AntiRec directory and then install all dependencies using pnpm:

    pnpm install
  3. Build and Run the Application

    To build and start the application in development mode, use the following command:

    pnpm tauri dev

    This will compile the project and open it in a new window. Any changes you make to the source code will automatically reload the application.

Clone this wiki locally