|
1 | 1 | # CineScreen |
2 | 2 |
|
| 3 | + |
| 4 | + |
| 5 | +<div align="center"> |
| 6 | + <img src="src/assets/icon.png" alt="CineScreen Icon" width="128"> |
| 7 | +</div> |
| 8 | + |
3 | 9 | A professional macOS screen recording application built with Electron that records your screen without the native cursor, tracks mouse movements separately, and provides a powerful post-processing studio for creating polished, cinematic screen recordings. |
4 | 10 |
|
5 | 11 | ### Result |
@@ -71,40 +77,20 @@ Support for Intel Macs (x64) and other platforms may be added in the future. |
71 | 77 | - **Vite** - Fast build tool for renderer process |
72 | 78 | - **Native Swift** - Mouse button state tracking |
73 | 79 |
|
74 | | -## Architecture |
75 | | - |
76 | | -The application follows a modular architecture: |
77 | | - |
78 | | -- **Main Process** (`src/main/`) - Handles screen capture, mouse tracking, and window management |
79 | | -- **Renderer Process** (`src/renderer/`) - UI for capture window and studio editor |
80 | | -- **Processing** (`src/processing/`) - Video processing, cursor rendering, zoom effects, and motion blur |
81 | | - - `cursor-utils.ts` - Shared cursor utilities (interpolation, easing, hotspots, click animations) |
82 | | - - `smooth-motion.ts` - Spring physics and SmoothDamp algorithms for glide effects |
83 | | - - `motion-blur.ts` - Directional motion blur using convolution kernels |
84 | | - - `sharp-renderer.ts` - Frame-by-frame video rendering with Sharp |
85 | | - - `zoom-tracker.ts` - Zoom region calculation and smoothing |
86 | | -- **Native Module** (`native/`) - Swift-based mouse button state detection |
87 | | - |
88 | 80 | ## Installation |
89 | 81 |
|
90 | | -### Prerequisites |
91 | | -- macOS (required for screen recording APIs) |
92 | | -- Node.js 18+ and npm |
93 | | -- Xcode Command Line Tools (for native module compilation) |
| 82 | +### Download from GitHub Releases |
94 | 83 |
|
95 | | -### Setup |
| 84 | +1. Go to the [Releases page](https://github.com/jasonzh0/CineScreen/releases) on GitHub |
| 85 | +2. Download the latest `.dmg` file from the assets section |
| 86 | +3. Open the downloaded DMG file |
| 87 | +4. Drag CineScreen to your Applications folder |
| 88 | +5. Launch CineScreen from Applications |
96 | 89 |
|
97 | | -```bash |
98 | | -# Clone the repository |
99 | | -git clone <repository-url> |
100 | | -cd CineScreen |
101 | | - |
102 | | -# Install dependencies |
103 | | -npm install |
104 | | - |
105 | | -# Build native modules |
106 | | -npm run build:native |
107 | | -``` |
| 90 | +**Note:** On first launch, macOS may warn you that the app is from an unidentified developer. To allow it: |
| 91 | +- Right-click (or Control-click) the app and select "Open" |
| 92 | +- Click "Open" in the security dialog |
| 93 | +- Or go to System Settings > Privacy & Security and click "Open Anyway" next to the warning message |
108 | 94 |
|
109 | 95 | ## Development |
110 | 96 |
|
|
0 commit comments