Skip to content

Fix build issues: Add cross-platform support #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix build issues: Add cross-platform support #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

Windows control server for the [Model Context Protocol](https://modelcontextprotocol.io/), providing programmatic control over system operations including mouse, keyboard, window management, and screen capture functionality.

> **Note**: This project currently supports Windows only.
> **Note**: Full automation features require Windows. Basic clipboard functionality is supported on all platforms.

## 🔥 Why MCPControl?

Expand All @@ -28,6 +28,8 @@ MCPControl bridges the gap between AI models and your desktop, enabling secure,

### Prerequisites

#### For full functionality (Windows only):

1. **Install Build Tools (including VC++ workload)**
```powershell
# Run as Administrator - may take a few minutes to complete
Expand All @@ -46,6 +48,12 @@ MCPControl bridges the gap between AI models and your desktop, enabling secure,
winget install OpenJS.NodeJS
```

#### For basic functionality (any platform):

1. **Install Node.js 18.0.0 or later**
- On Linux/macOS: Use your package manager or download from [nodejs.org](https://nodejs.org/)
- On Windows: `winget install OpenJS.NodeJS`

### Installation

1. **Install MCPControl Package**
Expand Down Expand Up @@ -238,9 +246,10 @@ By using this software, you acknowledge and accept that:

MCPControl supports multiple automation providers for different use cases:

- **keysender** (default) - Native Windows automation with high reliability
- **powershell** - Windows PowerShell-based automation for simpler operations
- **autohotkey** - AutoHotkey v2 scripting for advanced automation needs
- **keysender** (default on Windows) - Native Windows automation with high reliability
- **powershell** - Windows PowerShell-based clipboard automation
- **autohotkey** - AutoHotkey v2 scripting for advanced Windows automation needs
- **clipboardy** (default on non-Windows) - Cross-platform clipboard operations

### Provider Configuration

Expand Down Expand Up @@ -323,7 +332,7 @@ npm install [email protected]
- Multiple screen functions may not work as expected, depending on setup
- The get_screenshot utility does not work with the VS Code Extension Cline. See [GitHub issue #1865](https://github.com/cline/cline/issues/1865)
- Some operations may require elevated permissions depending on the target application
- Only Windows is supported
- Full automation features require Windows, but clipboard functionality works on all platforms
- MCPControl works best at 1280x720 resolution, single screen. Click accuracy is optimized for this resolution. We're working on an offset/scaling bug and looking for testers or help creating testing tools

## 👥 Contributing
Expand Down
Loading
Loading