CLAUDE.md

1# CLAUDE.md
2 
3This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4 
5## Build and Development Commands
6 
7**Build the application:**
8```bash
9npm run build
10```
11 
12**Run the application in development:**
13```bash
14npm run dev
15```
16 
17**Run the application (production):**
18```bash
19npm start
20```
21 
22**Package the application:**
23```bash
24npm run package
25```
26 
27## Architecture Overview
28 
29This is an Electron application built with TypeScript and React that manages development environments for the Steam game "Schedule I". The application provides automated branch management, DepotDownloader integration, and comprehensive Steam library detection.
30 
31### Core Architecture Patterns
32 
33**Electron Multi-Process Architecture**: The application uses Electron's standard architecture:
34- **Main Process**: Node.js backend handling system operations and Steam integration
35- **Renderer Process**: React frontend with secure IPC communication
36- **Preload Script**: Secure bridge between main and renderer processes
37 
38**IPC Communication**: All communication between processes uses Electron's IPC system with type-safe interfaces defined in the preload script.
39 
40### Key Components
41 
42**Main Process Services** (`src/main/services/`):
43- `ConfigService`: Manages persistent configuration storage in AppData with DepotDownloader settings
44- `LoggingService`: File-based logging implementation
45- `CredentialService`: Secure Steam credential storage and encryption
46- `UpdateService`: Application update checking and management
47 
48**IPC Handlers** (`src/main/ipc/`):
49- `steamHandlers.ts`: Steam library detection, manifest parsing, and branch detection
50- `depotdownloaderHandlers.ts`: DepotDownloader integration replacing legacy SteamCMD
51- `configHandlers.ts`: Configuration management operations
52- `fileHandlers.ts`: File operations with progress tracking
53- `steamLoginHandlers.ts`: Steam authentication and credential management
54 
55**React Components** (`src/renderer/components/`):
56- `SetupWizard/`: Multi-step setup process with DepotDownloader configuration
57- `ManagedEnvironment/`: Main interface for environment management
58- `Settings/`: Configuration and preferences management
59- Progress dialogs and confirmation components
60 
61**Shared Types** (`src/shared/types.ts`):
62- `DevEnvironmentConfig`: Central configuration interface with DepotDownloader integration
63- Steam-related interfaces and branch management types
64 
65### Application State Management
66 
67**Configuration Storage**: Uses JSON serialization to AppData (`%LOCALAPPDATA%\TVGS\Schedule I\Developer Env\config\`)
68 
69**Branch Management**: Supports four branch types: main-branch, beta-branch, alternate-branch, alternate-beta-branch
70 
71**DepotDownloader Integration Features**:
72- Modern Steam depot downloading with simplified command syntax
73- Automatic Steam Guard support with QR codes
74- Parallel downloads with configurable thread counts
75- Better error handling and progress reporting compared to legacy SteamCMD
76- Installation via Windows Package Manager (winget) or manual download
77- Manifest-based build ID extraction for branch verification
78 
79**Steam Integration Features**:
80- Automatic Steam library detection with multi-library support
81- Steam manifest parsing for build ID extraction
82- Branch detection via Steam's appinfo files
83- Wait-for-branch-switch functionality for user-initiated Steam branch changes
84 
85### UI Design Principles
86 
87**Modern Electron Interface**: Dark-themed interface with:
88- Custom title bar with window controls
89- Progress tracking for file operations
90- Multi-step setup wizard
91- Responsive layout design
92 
93**User Experience**: Prioritizes simplicity and automation:
94- Guided setup process with validation
95- Real-time progress feedback
96- Clear error messaging and recovery options
97 
98### Dependencies
99 
100**Core Framework**:
101- Electron with TypeScript
102- React for the renderer process
103- Node.js backend services
104 
105**Key Dependencies**:
106- `electron`: Application framework
107- `react`: UI library for renderer process
108- Various Node.js packages for Steam integration and file operations
109 
110## Development Notes
111 
112**DepotDownloader Migration**:
113- Migrated from legacy SteamCMD to modern DepotDownloader for improved reliability
114- Simplified command syntax: `-app 3164500 -branch beta -username user -password pass -dir path`
115- Better Steam Guard support with QR code authentication
116- Parallel downloads with configurable thread counts
117- Enhanced error handling and progress reporting
118 
119**Key Technical Details**:
120- **Steam App ID**: Schedule I is hardcoded as "3164500"
121- **Branch Mapping**: main-branch → public, beta-branch → beta, etc.
122- **Build ID Extraction**: Uses manifest files instead of SteamCMD's app_info_print
123- **Configuration**: Stored in `%LOCALAPPDATA%\TVGS\Schedule I\Developer Env\config\`
124 
125**Architecture Patterns**:
126- IPC handlers in main process for all system operations
127- Type-safe API exposure through preload script
128- React components with progress tracking and validation
129- Secure credential storage with encryption
130 
131**Testing Strategy**:
132- Manual testing of UI flows and Steam integration
133- Validation of DepotDownloader installation and authentication
134- Progress tracking verification for file operations
135- Configuration persistence testing
136 
137**File Operations**: Large file operations (environment copying and downloading) show progress with proper cancellation support through Electron IPC communication.