Installation

Needlecast is available for Windows, macOS, and Linux. Choose your platform below for installation instructions.

Windows

Installer (Recommended)

Download the latest needlecast-VERSION-win64.exe from GitHub Releases
Run the installer and follow the prompts
Needlecast will appear in your Start Menu

Portable Version

Download needlecast-VERSION-windows.zip
Extract to any folder
Run needlecast.exe

macOS

DMG Package

Download needlecast-VERSION-macos.dmg
Open the DMG file
Drag Needlecast to your Applications folder
Launch from Applications or Spotlight

Linux

Debian/Ubuntu

# Download the .deb package
wget https://github.com/rygel/needlecast/releases/download/v0.6.17/needlecast-0.6.17-linux-amd64.deb

# Install with dpkg
sudo dpkg -i needlecast-*.deb

# Install dependencies if needed
sudo apt-get install -f

AppImage

Download needlecast-VERSION-linux.AppImage
Make it executable:
```
chmod +x needlecast-*.AppImage
```
Run directly:
```
./needlecast-*.AppImage
```

From Source

If you prefer to build from source:

Prerequisites

Java 21 or later
Maven 3.9+

Build and Run

git clone https://github.com/rygel/needlecast.git
cd needlecast
mvn -pl needlecast-desktop compile exec:java

System Requirements

Java: Version 21 or later
Memory: 512MB minimum, 1GB recommended
Storage: 100MB for application, plus space for projects
OS: Windows 10+, macOS 10.15+, or modern Linux distribution

Next Steps

After installation, see First Launch to set up your first projects.