Joby/cursor_rush
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with current versions and accurate info

Browse Source
This commit is contained in:
Joby
2025-05-30 23:26:41 -05:00
parent 7016e96673
commit 67ee3dc8d1
1 changed files with 48 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+48 -12
View File
@@ -42,23 +42,25 @@ frontend/
### Prerequisites ### Prerequisites
- Rust 1.70.0 or later - Rust 1.56.0 or later (tested with 1.86.0)
- Cargo - Cargo
- Node.js 16.0.0 or later - Node.js 16.0.0 or later (tested with 20.11.0)
- npm 7.0.0 or later - npm 7.0.0 or later (tested with 10.2.4)
- Platform-specific dependencies: - Platform-specific dependencies:
- Windows: None (fully supported) - Windows: Visual Studio Build Tools (fully supported)
- macOS: Development in progress - macOS: Development in progress
- Linux: Development in progress - Linux: Development in progress
### Dependencies ### Dependencies
The application uses the following major dependencies: The application uses the following major dependencies:
- Tauri 1.6.0 - Cross-platform framework - Tauri 1.8.3 - Cross-platform framework
- React - Frontend framework - React 19.1.0 - Frontend framework
- image 0.24.7 - Image processing - image 0.24 - Image processing
- winapi 0.3.9 - Windows API bindings - winapi 0.3.9 - Windows API bindings
- once_cell 1.19.0 - Lazy initialization - once_cell 1.19.0 - Lazy initialization
- steamworks 0.11.0 - Steam integration
- parking_lot 0.12.3 - High-performance synchronization
### Build Commands ### Build Commands
@@ -69,11 +71,15 @@ cd frontend
# Install npm dependencies # Install npm dependencies
npm install npm install
# Run in development mode # Run in development mode (starts both frontend and backend)
npm run tauri dev npm run tauri dev
# Build for production # Build for production
npm run tauri build npm run tauri build
# Alternative: Run frontend and backend separately for debugging
# Terminal 1: npm run dev (starts Vite dev server)
# Terminal 2: npm run tauri dev --no-dev-server (starts Tauri without dev server)
``` ```
## Usage ## Usage
@@ -95,11 +101,16 @@ The application comes with sample cursors:
- `red.png` - A red-colored cursor - `red.png` - A red-colored cursor
To add your own cursors: To add your own cursors:
1. Create PNG images with transparent backgrounds 1. Create PNG or CUR images with transparent backgrounds
2. Place them in the `frontend/src/cursors` directory 2. Place them in the `frontend/src/cursors` directory
3. Restart the application to load the new cursors 3. Restart the application to load the new cursors
4. The cursor name in the UI will be derived from the filename 4. The cursor name in the UI will be derived from the filename
**Note**: The application automatically scans multiple directories for cursor files:
- `frontend/src/cursors/` (recommended location)
- `frontend/src-tauri/src/cursors/`
- `frontend/src-tauri/cursors/`
## Hotkeys ## Hotkeys
- Ctrl+Shift+F12: Exit the application (restores original system cursor) - Ctrl+Shift+F12: Exit the application (restores original system cursor)
@@ -120,17 +131,42 @@ To add your own cursors:
- The application uses event-driven cursor updates instead of polling when possible - The application uses event-driven cursor updates instead of polling when possible
- Cursor images are cached to improve performance when switching between cursors - Cursor images are cached to improve performance when switching between cursors
## Previously Fixed Issues ## Known Issues & Status
### Recently Fixed Issues
The following issues have been addressed in recent updates: The following issues have been addressed in recent updates:
- Task Manager compatibility: The application now properly handles elevated applications - Task Manager compatibility: The application now properly handles elevated applications
- System tray menu stability: Fixed issues with the tray menu disappearing when mousing over it - System tray menu stability: Fixed issues with the tray menu disappearing when mousing over it
### Current Known Issues
- Some system tray menu interactions may still be inconsistent on certain Windows versions
- Z-ordering issues where custom cursor may hide behind system tray menus due to Windows UI prioritization
- Performance may be affected when Task Manager or other elevated applications are open due to Windows security restrictions
## Steam Integration ## Steam Integration
The application includes integration with the Steam API for future gameified features: The application includes integration with the Steam API (AppID: 1430270):
- Shows as an active game in Steam for time tracking purposes
- Steam integration initializes automatically when the application starts
- Item drop functionality is implemented but not yet active - Item drop functionality is implemented but not yet active
- Steam must be running for this functionality to work - Steam must be running for the integration to work properly
- The application will appear in your Steam library as "running" while active
## Troubleshooting
### Build Issues
- **Missing Visual C++ Redistributable**: Install Visual Studio Build Tools or Visual C++ Redistributable packages
- **Node.js library issues**: Reinstall Node.js (version 16.0.0 or later) and ensure all dependencies are properly installed
- **Rust compilation errors**: Ensure Rust 1.56.0 or later is installed and up to date
### Runtime Issues
- **Application won't start**: Check that all dependencies are installed and Steam is running (if using Steam integration)
- **Cursor not changing**: Verify cursor files exist in the correct directory and have proper file permissions
- **System tray issues**: Try restarting the application or check Windows notification area settings
### Development Issues
- **Tauri dev server not starting**: Ensure port 5173 is available or specify a different port
- **Hot reload not working**: Check that the Vite dev server is running properly in the background
## Contributing ## Contributing