Skip to content

installation.md

Latest commit

 

History

History
118 lines (84 loc) · 3.81 KB

installation.md

File metadata and controls

118 lines (84 loc) · 3.81 KB

Installation

Get SwitchCraft up and running in minutes.

Recommended: Windows Package Manager (winget)

The easiest way to install SwitchCraft on Windows:

winget install FaserF.SwitchCraft

This installs the Modern edition with automatic updates.

Manual Download

Download the latest release from GitHub Releases.

Available Editions

Edition Download Best For
Modern (Flet) Setup / Portable Most users - Latest features, modern UI
Legacy (Tkinter) Setup / Portable Old hardware - Lightweight, classic stability
CLI Download Automation - Headless, scriptable

File Guide

Filename Type Description
SwitchCraft-Setup.exe Installer Modern edition with auto-updates
SwitchCraft-windows.exe Portable Modern edition, no installation needed
SwitchCraft-Legacy-Setup.exe Installer Legacy edition
SwitchCraft-Legacy.exe Portable Legacy edition
SwitchCraft-CLI-windows.exe CLI Command-line tool

System Requirements

Requirement Minimum
OS Windows 10 (Build 1809+) or Windows 11
Architecture x64
RAM 4 GB
Disk ~150 MB

Optional Dependencies

  • 7-Zip: Required for nested installer extraction. Download
  • IntuneWinAppUtil: Auto-downloaded when needed for Intune packaging.

Portable vs Installer

Installer (Setup.exe)

  • ✅ Start menu shortcuts
  • ✅ Automatic updates
  • ✅ File associations
  • ❌ Requires admin rights

Portable (.exe)

  • ✅ No installation required
  • ✅ Run from USB drive
  • ✅ Use in Windows Sandbox
  • ❌ No auto-updates

First Launch

  1. Accept Firewall Prompt (if shown) - Required for local UI server
  2. Configure Settings - Set your preferred theme, language, and Intune credentials
  3. Install Addons - Enable advanced features like AI assistance or Intune integration

Tip

Run SwitchCraft as Administrator to enable local installation testing features.

Uninstallation Options

The SwitchCraft uninstaller (unins000.exe in the install folder) supports standard Inno Setup flags and a custom cleanup flag.

Factory Reset Uninstall

To completely remove SwitchCraft, including all configuration, history, and addons, use the /FULLCLEANUP parameter.

# Silent uninstall with full data cleanup
./unins000.exe /VERYSILENT /FULLCLEANUP

What gets deleted?

  • Installation Directory ({app})
  • User Preferences Registry (HKCU\Software\FaserF\SwitchCraft)
  • Roaming AppData (%APPDATA%\FaserF\SwitchCraft)
  • Local AppData (%LOCALAPPDATA%\FaserF\SwitchCraft)
  • Addons (%USERPROFILE%\.switchcraft)

Data Storage Locations

SwitchCraft stores configuration and user data in the following locations.

Windows

Type Location
User Preferences HKCU\Software\FaserF\SwitchCraft
GPO/Intune Policies HKCU\Software\Policies\FaserF\SwitchCraft
Analysis History %APPDATA%\FaserF\SwitchCraft\history.json
Logs / Crash Dumps %APPDATA%\FaserF\SwitchCraft\Logs\
Addons %USERPROFILE%\.switchcraft\addons\
Secrets (API Keys) Windows Credential Manager (under "SwitchCraft")

Linux / macOS

Type Location
Addons ~/.switchcraft/addons/
Logs ~/.switchcraft/Logs/
Secrets System Keyring (libsecret/Keychain)