/AutoHotKey

A collection of my custom AutoHotKey scripts for automating various tasks, including browser automation, game macros, and more. This repository features a variety of AutoHotKey (AHK) scripts designed for improving productivity across multiple domains, such as web browsing, gaming, and desktop automation.

Primary LanguageAutoHotkeyApache License 2.0Apache-2.0


Welcome to the AutoHotKey. repository. It stores a collection of my custom AutoHotKey scripts for automating various tasks, including browser automation, game macros, and more.


GitHub Code Size in Bytes GitHub Commits GitHub Last Commit GitHub Forks GitHub Language Count GitHub License GitHub Stars wakatime

RepoBeats Statistics

Table of Contents

Introduction

This repository contains a collection of AutoHotkey (AutoHotkey Official Website) scripts aimed at enhancing productivity in various areas, including web browsing, gaming, and desktop automation.

AutoHotkey (AHK) is a flexible and powerful scripting language for Windows, designed to simplify the automation of repetitive tasks and the creation of custom keyboard shortcuts. AHK allows users to streamline processes like filling forms, remapping keys, managing windows, and automating complex workflows, making it an essential tool for users looking to improve efficiency.

How AutoHotkey Works

AutoHotkey scripts are typically saved with the .ahk file extension and executed by the AutoHotkey interpreter. Once a script is running, it monitors your system for specific keyboard and mouse inputs (or other events) and reacts according to the instructions within the script. For instance, it can send keystrokes, automate mouse clicks, or even execute more complex logic to interact with applications.

The script structure consists of:

  • Hotkeys: Bindings that trigger certain actions when specific keys or key combinations are pressed.
  • Hotstrings: Automatic text replacements that expand shortcuts into full phrases.
  • Control Flow: Conditional logic, loops, and functions to create powerful automation routines.

Versions: AHK v1 vs AHK v2 (Important Compatibility Note)

As of the writing of this README, AutoHotkey has two major versions: AHK v1 and AHK v2.

  • AHK v1 is the older version, widely used and with extensive community support.
  • AHK v2 is the newer version, featuring a cleaner and more structured syntax that improves the language's readability and maintainability.

However, these versions are incompatible, which means that scripts written for AHK v1 will not work with the AHK v2 interpreter without modification, and vice versa. This is important to keep in mind when learning AutoHotkey or writing your own scripts. Make sure you are using the correct version of the interpreter that matches the script's syntax. If you’re unsure, check which version a script is designed for, as running a v1 script in v2 will cause errors, and the same is true the other way around.

Requirements

To run any of the scripts in this repository, you will need to have AutoHotKey installed on your Windows machine. AutoHotKey is a free, open-source scripting language for Windows that allows users to create custom scripts for automating tasks, remapping keys, and creating custom keyboard shortcuts. You can download AutoHotKey from the official website at https://www.autohotkey.com.

Setup

Clone the repository

  1. Clone the repository with the following command:
git clone https://github.com/BrenoFariasDaSilva/AutoHotKey.git
cd AutoHotKey

Usage

In order to run a script, you need to have the AutoHotKey interpreter installed on your system. Once you have AutoHotKey installed, you can run any script by double-clicking on the script file or by right-clicking on the script file and selecting "Run Script" from the context menu.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have suggestions for improving the code, your insights will be highly welcome. In order to contribute to this project, please follow the guidelines below or read the CONTRIBUTING.md file for more details on how to contribute to this project, as it contains information about the commit standards and the entire pull request process. Please follow these guidelines to make your contributions smooth and effective:

  1. Set Up Your Environment: Ensure you've followed the setup instructions in the Setup section to prepare your development environment.

  2. Make Your Changes:

    • Create a Branch: git checkout -b feature/YourFeatureName
    • Implement Your Changes: Make sure to test your changes thoroughly.
    • Commit Your Changes: Use clear commit messages, for example:
      • For new features: git commit -m "FEAT: Add some AmazingFeature"
      • For bug fixes: git commit -m "FIX: Resolve Issue #123"
      • For documentation: git commit -m "DOCS: Update README with new instructions"
      • For refactorings: git commit -m "REFACTOR: Enhance component for better aspect"
      • For snapshots: git commit -m "SNAPSHOT: Temporary commit to save the current state for later reference"
    • See more about crafting commit messages in the CONTRIBUTING.md file.
  3. Submit Your Contribution:

    • Push Your Changes: git push origin feature/YourFeatureName
    • Open a Pull Request (PR): Navigate to the repository on GitHub and open a PR with a detailed description of your changes.
  4. Stay Engaged: Respond to any feedback from the project maintainers and make necessary adjustments to your PR.

  5. Celebrate: Once your PR is merged, celebrate your contribution to the project!

Collaborators

We thank the following people who contributed to this project:

My Profile Picture
Breno Farias da Silva

License

Apache License 2.0

This project is licensed under the Apache License 2.0. This license permits use, modification, distribution, and sublicense of the code for both private and commercial purposes, provided that the original copyright notice and a disclaimer of warranty are included in all copies or substantial portions of the software. It also requires a clear attribution back to the original author(s) of the repository. For more details, see the LICENSE file in this repository.