Skip to content

Latest commit

 

History

History
223 lines (138 loc) · 6.71 KB

README.md

File metadata and controls

223 lines (138 loc) · 6.71 KB
Raw

AutoWiz

Descriptive Text for Image

 

AutoWiz is a powerful and user-friendly automation tool designed to record and playback your keyboard and mouse actions with precision and ease. Whether you're looking to automate repetitive tasks, create macros, or streamline your workflow, AutoWiz has got you covered.

Disclaimer: AutoWiz is intended for legitimate and ethical use only. Users are responsible for ensuring that their use of AutoWiz complies with all applicable laws and regulations. The developers are not liable for any misuse or damages resulting from the use of this software. Additionally, due to its ability to automate mouse and keyboard interactions, AutoWiz may occasionally be flagged by antivirus software that uses AI-based detection as a false positive. This is not indicative of malicious behavior but rather a result of heuristic detection methods commonly used in such software.

Table of Contents

Features

  • Record Keyboard and Mouse Actions: Capture all your keyboard presses and mouse movements, clicks, and scrolls.
  • Playback with Adjustable Speed: Play back your recordings at your preferred speed, from half-speed to double-speed.
  • Loop Playback: Enable continuous playback of your recordings until you decide to stop.
  • Save and Manage Recordings: Easily save your recordings, load existing ones, and delete unwanted recordings.
  • Compact and Regular Modes: Toggle between a detailed interface and a streamlined compact mode for convenience.
  • Always on Top: Keep AutoWiz visible on your screen by enabling the "Always on Top" feature.
  • Visual Status Indicators: Stay informed about the current state of AutoWiz with color-coded status indicators and progress bars.
  • Help and About Sections: Access comprehensive help documentation and information about AutoWiz directly within the application.

Demo

(coming soon)

Installation

Prerequisites

  • Python 3.7 or higher: Ensure you have Python installed on your system. You can download it from python.org.

Steps

  1. Clone the Repository

    Navigate to your desired directory and clone the AutoWiz repository:

    git clone https://github.com/techcow2/autowiz.git

  2. Navigate to the Directory

    cd autowiz

  3. Create a Virtual Environment (Optional but Recommended)

    python -m venv venv

  4. Activate the Virtual Environment

    • Windows:

      venv\Scripts\activate

    • macOS and Linux:

      source venv/bin/activate

  5. Install Required Dependencies

    pip install -r requirements.txt

Usage

  1. Run AutoWiz

    python app.py

  2. Recording Actions

    • Click the Record button or press the R key to start recording your keyboard and mouse actions.
    • Perform the actions you wish to automate.
    • Press the ESC key to stop recording.

  3. Playing Back Actions

    • Select a saved recording from the dropdown menu.
    • Click the Play button to start playback.
    • Adjust the Playback Speed slider to your desired speed.
    • Enable or disable Loop Playback as needed.
    • Click the Stop button or press the ESC key to halt playback.

  4. Managing Recordings

    • Save Recording: After recording, click Save Recording to name and store your actions.
    • Load Recording: Select a recording from the dropdown and click Load Recording to prepare it for playback.
    • Delete Recording: Remove unwanted recordings by selecting them and clicking Delete Recording.

  5. Additional Features

    • Compact Mode: Toggle between regular and compact interfaces for a streamlined experience.
    • Always on Top: Keep AutoWiz visible above other windows by enabling this feature.
    • Help and About: Access detailed help documentation and information about AutoWiz through the respective buttons.

Configuration

AutoWiz stores its configurations and recordings in the following directories:

  • Recordings Directory: recordings/
  • Configuration File: config.json

Ensure these files and directories are present in the root directory of the application. The application will automatically create the recordings directory if it doesn't exist.

Hotkeys

AutoWiz supports global hotkeys for enhanced convenience:

  • Start Recording: Press R
  • Stop Recording or Playback: Press ESC

Note: Ensure that AutoWiz is running and has the necessary permissions to capture global hotkeys.

Screenshots

Regular Mode

Regular Mode

Compact Mode

Compact Mode

Recording Status

Recording Status

Contributing

Contributions are what make the open-source community thrive! We appreciate any contributions you make to AutoWiz.

Steps to Contribute

  1. Fork the Repository

    Click the Fork button at the top right of this page.

  2. Clone Your Fork

    git clone https://github.com/techcow2/autowiz.git

  3. Create a New Branch

    git checkout -b feature/YourFeatureName

  4. Make Your Changes

    Implement your feature or bug fix.

  5. Commit Your Changes

    git commit -m "Add Your Feature"

  6. Push to Your Fork

    git push origin feature/YourFeatureName

  7. Open a Pull Request

    Navigate to the original repository and click New Pull Request.

Guidelines

  • Follow the existing code style and conventions.
  • Ensure that your code is well-documented.
  • Test your changes thoroughly before submitting.

License

Distributed under the MIT License. See LICENSE for more information.

Support

Have questions or need support? Open an issue!

© 2024 TechRayApps LLC. All rights reserved.