win-auto-utils 0.2.1

Universal Windows automation utilities with memory, window, input, and color operations
docs.rs failed to build win-auto-utils-0.2.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Win Auto Utils

ไธญๆ–‡ๆ–‡ๆกฃ | English Documentation

A universal Windows automation utility library providing atomic modules for memory operations, window management, input simulation, and color processing. Built with Rust for performance and safety.

๐Ÿš€ Features

Core Capabilities

  • Process Management: Process enumeration, handle aggregation, module snapshot (ToolHelp32)
  • Window Operations: Window handle queries, enumeration, manipulation, DC management
  • Input Simulation: Keyboard input (Key Down/Up/Press), mouse click & movement
  • Screen Capture: High-performance DXGI-based capture, GDI color picking
  • Color Processing: Pure Rust pixel color finding algorithms (zero dependencies)
  • Memory Operations: Read/write process memory, address resolution, AOB scanning
  • Hooking System: Inline hooks, trampoline hooks, register extraction
  • Script Engine: Pure Rust interpreter with control flow, timing, keyboard/mouse instructions
  • DLL Injection: Cross-architecture injection (x64โ†’x86/x64, WOW64 compatible)
  • Template Matching: Image-based UI element detection with parallel processing

Key Advantages

โœ… Atomic Design: Enable only what you need via feature flags
โœ… Minimal Dependencies: Core features depend only on windows crate
โœ… Performance: Release mode with LTO, size optimization, symbol stripping
โœ… Safety: Rust's ownership system prevents common memory errors
โœ… Cross-platform Script Engine: Pure Rust, no external dependencies

๐Ÿ“ฆ Installation

Add to your Cargo.toml:

[dependencies]

win-auto-utils = { version = "0.2.0", features = ["standard"] }

For full functionality including template matching:

[dependencies]

win-auto-utils = { version = "0.2.0", features = ["full"] }

๐ŸŽฏ Quick Start

Process Management

Only three types needed for full functionality!

use win_auto_utils::process::{Process, ProcessConfig, ProcessManager};

// Method 1: One-step initialization by name (most convenient)
let mut process = Process::init_by_name("notepad.exe")?;
println!("PID: {}", process.pid_or_default());

// Method 2: One-step initialization by PID (when you know the PID)
let process = Process::init_by_pid(12345)?;
println!("HWND: {:?}", process.hwnd_or_default());

// Method 3: Using Builder with intuitive methods (no enums needed!)
let config = ProcessConfig::builder("target.exe")
    .set_window_client_mode()  // Easy to remember - no DCMode enum!
    .exclude_invisible()
    .include_by_title("Game Window")
    .build();
let mut game = Process::new(config);
game.init()?;

// Method 4: Instance method init_with_pid (for existing Process objects)
// Useful for distinguishing multiple instances of the same process
let mut app = Process::by_name("target.exe");
app.init()?;  // Initialize first instance
// Later, switch to specific PID for second instance
app.init_with_pid(20908)?;

// Manager API (simple and straightforward):
let mut manager = ProcessManager::new();
manager.register("notepad.exe")?;  // process name becomes the key
manager.register_alias("game", "target.exe")?;  // custom alias
manager.init("notepad.exe")?;
manager.init_with_pid("game", 12345)?;  // initialize with specific PID

// Query processes (read-only, no mut needed)
if let Some(proc) = manager.get("notepad.exe") {
    println!("PID: {:?}", proc.pid());
}

// DC Mode Options (intuitive method names):
// - .set_window_mode()        -> Standard window DC (GetWindowDC)
// - .set_window_client_mode() -> Client area DC (GetDC) - best for games
// - .set_desktop_mode()       -> Desktop DC for full-screen capture

Memory Operations

use win_auto_utils::memory::{read_memory_t, write_memory_t};

// Read a 32-bit integer
let value: i32 = read_memory_t(handle, address)?;

// Write a float value
write_memory_t::<f32>(handle, address, 999.0)?;

Input Simulation

use win_auto_utils::keyboard::key_press;
use win_auto_utils::mouse::{move_to, left_click};

// Press 'A' key
key_press(handle, 0x41)?;

// Move mouse and click
move_to(handle, 100, 200)?;
left_click(handle)?;

Screen Capture (DXGI)

use win_auto_utils::dxgi::DxgiCapture;

let mut capture = DxgiCapture::new()?;
let image = capture.capture_window(hwnd)?;

Memory Hooking

use win_auto_utils::memory_hook::TrampolineHook;

let shellcode = vec![0x01, 0xD2]; // add edx, edx
let mut hook = TrampolineHook::x86(handle, target_addr, shellcode);
hook.install()?;
// ... trigger hook ...
hook.uninstall()?; // Auto-frees memory

Script Engine

use win_auto_utils::script_engine::ScriptEngine;

let script = r#"
    loop 10
        key VK_SPACE
        sleep 100
    end
"#;

let mut engine = ScriptEngine::new();
engine.execute(script)?;

๐Ÿ“š Documentation

Comprehensive documentation is available in both English and Chinese:

Quick Links

Module Documentation

English

Chinese (ไธญๆ–‡)

๐Ÿ—๏ธ Architecture

The library follows a modular architecture with feature-gated components:

win-auto-utils/
โ”œโ”€โ”€ Process & Window Layer
โ”‚   โ”œโ”€โ”€ process      - Process management
โ”‚   โ”œโ”€โ”€ hwnd         - Handle queries
โ”‚   โ”œโ”€โ”€ window       - Window manipulation
โ”‚   โ””โ”€โ”€ snapshot     - ToolHelp32 enumeration
โ”‚
โ”œโ”€โ”€ Input Layer
โ”‚   โ”œโ”€โ”€ keyboard     - Keyboard simulation
โ”‚   โ””โ”€โ”€ mouse        - Mouse control
โ”‚
โ”œโ”€โ”€ Graphics Layer
โ”‚   โ”œโ”€โ”€ dxgi         - Screen capture
โ”‚   โ”œโ”€โ”€ color_picker - GDI color picking
โ”‚   โ””โ”€โ”€ color_finder - Pixel color search
โ”‚
โ”œโ”€โ”€ Memory Layer
โ”‚   โ”œโ”€โ”€ memory       - Basic read/write
โ”‚   โ”œโ”€โ”€ memory_resolver - Symbolic addresses
โ”‚   โ”œโ”€โ”€ memory_aobscan  - Pattern scanning
โ”‚   โ””โ”€โ”€ memory_hook     - Inline/trampoline hooks
โ”‚
โ”œโ”€โ”€ Advanced Features
โ”‚   โ”œโ”€โ”€ dll_injector    - DLL injection
โ”‚   โ””โ”€โ”€ template_matcher - Image matching
โ”‚
โ””โ”€โ”€ Script Engine
    โ”œโ”€โ”€ script_engine      - Core interpreter
    โ””โ”€โ”€ scripts_builtin    - Built-in instructions

๐Ÿ”ง Feature Flags

Choose only what you need:

Minimal Setup (~15s compilation)

cargo build --no-default-features --features "keyboard,mouse"

Core Features (default)

cargo build  # Includes all stable features except template_matcher

Full Features (~45-60s compilation)

cargo build --no-default-features --features "full"

Available Features

Feature Description Dependencies
process Process management windows, hwnd, hdc, snapshot, handle
keyboard Keyboard input windows
mouse Mouse control windows
memory Memory read/write windows
memory_hook Hooking system memory, windows
memory_aobscan Pattern scanning memory, memchr, rayon
dxgi Screen capture windows
template_matcher Image matching image, imageproc, rayon
script_engine Script interpreter (none, pure Rust)
dll_injector DLL injection snapshot, windows

See Cargo.toml for complete feature list.

๐Ÿ“– Examples

Explore the examples/ directory for usage demonstrations:

# Run script engine example

cargo run --example script_engine --features "script_engine"


# Run DXGI capture example

cargo run --example dxgi_capture --features "dxgi"


# Run memory hook example

cargo run --example memory_hook_reset --features "memory_hook"


# Run AOB scan benchmark

cargo run --example aobscan_benchmark --features "memory_aobscan"

๐Ÿงช Testing

Run tests for specific modules:

# Test script engine

cargo test --features "script_engine"


# Test built-in instructions

cargo test --features "scripts_builtin"


# Test memory operations

cargo test --features "memory"