Examples

This section contains practical examples for common use cases with the Makcu library. Each example includes both synchronous and asynchronous versions where applicable.

Quick Start Examples

Here are some quick examples to get you started:

Basic Mouse Control

from makcu import create_controller, MouseButton

# Simple click and move
makcu = create_controller()
makcu.click(MouseButton.LEFT)
makcu.move(100, 50)
makcu.disconnect()

Async Version

import asyncio
from makcu import create_async_controller, MouseButton

async def main():
    async with await create_async_controller() as makcu:
        await makcu.click(MouseButton.LEFT)
        await makcu.move(100, 50)

asyncio.run(main())

Gaming Example

from makcu import create_controller, MouseButton

makcu = create_controller(debug=False)  # Max performance

# Ultra-fast gaming clicks
makcu.click_human_like(MouseButton.LEFT, profile="gaming")

# Precise movement
makcu.move_smooth(200, 100, segments=30)

Choose Your Use Case

🎮 Gaming Applications

High-performance mouse control for competitive gaming, with sub-3ms response times and parallel operations.

→ See: gaming_applications, high_performance_gaming

🤖 Automation Scripts

Automate repetitive tasks with human-like mouse movements and intelligent timing.

→ See: automation_scripts, human_like_interactions

🌐 Web Applications

Integrate mouse control into web servers, APIs, and online services.

→ See: web_integration, fastapi_web_app

💬 Discord/Chat Bots

Add mouse control commands to Discord bots and chat applications.

→ See: discord_bot

🖥️ GUI Applications

Embed mouse control into desktop applications with proper async integration.

→ See: gui_applications

⚡ High Performance

Maximize performance for real-time applications requiring minimal latency.

Performance Comparison

Here’s how different approaches perform:

Performance by Use Case
Use Case	Sync Performance	Async Performance	Best For
Gaming	~2ms per operation	~1ms per operation	Real-time gaming
Automation	~5ms per operation	~3ms per operation	Scripts & bots
Web Apps	Blocking	Non-blocking	Server applications
Bulk Operations	Sequential	Parallel	Large datasets

Code Standards

All examples follow these standards:

✅ Error Handling: Proper exception handling
✅ Resource Cleanup: Context managers and proper disconnection
✅ Type Hints: Full type annotations for clarity
✅ Documentation: Detailed comments and docstrings
✅ Performance: Optimized for their specific use case
✅ Modern Python: Uses Python 3.7+ features and best practices

Running Examples

Each example can be run directly:

# Download example
curl -O https://raw.githubusercontent.com/SleepyTotem/makcu-py-lib/main/examples/basic_mouse_control.py

# Run example
python basic_mouse_control.py

Or integrated into your own projects:

# Import and adapt
from examples.gaming_applications import gaming_combo

# Use in your code
await gaming_combo()

Contributing Examples

Have a great example to share? We’d love to include it!

Example Requirements:

Clear Purpose: Solves a specific, common use case
Well Documented: Comments explaining what each part does
Error Handling: Proper exception handling
Performance: Optimized for its use case
Both Versions: Include sync and async versions if applicable

Submit via:

GitHub Pull Request to the examples/ directory
GitHub Discussions with your code
GitHub Issues tagged as “example request”

Next Steps

📖 Browse Examples: Pick your use case from the list above
💻 Try the Code: Copy and run examples locally
🔧 Adapt for Your Needs: Modify examples for your specific requirements
🚀 Build Something Cool: Use examples as starting points for your projects
🤝 Share Back: Contribute your own examples to help others!