Repository files navigation

AMac Rectangle inspired window manager for Windows 10/11 powered by AutoHotkey.

Polygon supports Windows 10/11.

You can grab the latest Polygon installer from the latestrelease. The installer will place a shortcut to your user startup folder to ensure that Polygon start at Windows logon.

If you rather want to install Polygon manually, please follow the steps outlined below.

• Download the compiled executable zip file based on your OS architecture from the latestrelease.
• Extract thepolygon-x[64|86].zip into a location of your choice.
• Right click the executable and unblock it if Windows complain about security.
• Open the user startup folder by running theshell:startup command in the run (WIN+R) window.
• Copy thepolygon-x[64|86].exe and thepolygon.ini that you downloaded from the previous step and copy them to theshell:startup directory.

If you followed everything correctly, Polygon should start at Windows logon.

Here are the shortcuts available in Polygon.

Have a bug or a feature request, please open a new issue.

Contributions are most welcome to fix bugs or to add new features.

• You need to haveAutoHotkey v2 installed.
• I recommend using Visual Studio Code or other VS Code based editors like Cursor.
• You need to have theAutoHotkey v2 Language Support extension installed by searching with thethqby.vscode-autohotkey2-lsp extension ID.
• If AutoHotkey is located in a different location other thanC:\Program Files\AutoHotkey\v2\AutoHotkey.exe, then set theAutoHotkey2.InterpreterPath setting to point to the correct location.
• You need to have theEditorConfig for VS Code extension installed by searching with theEditorConfig.EditorConfig extension ID.
• You need to have thePrettier - Code formatter extension installed by searching with theesbenp.prettier-vscode extension ID.
• Add the following lines to your VS Code settings.json file to enable AutoHotkey v2 language support.

  {"AutoHotkey2.InterpreterPath":"<path to AutoHotkey.exe>","AutoHotkey2.Warn.LocalSameAsGlobal":true,"AutoHotkey2.Warn.CallWithoutParentheses":"On"}

The repository is structured pretty flat to keep things simple and find all necessary files easily. Polygon is developed as a single AHK file namedpolygon.ahk for now. I may in the future refactor it into multiple files if the push comes to shove.

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit I kindly ask you to follow the conventioncategory(scope): message in your commit message while using one of the following categories:

• feat: all changes that introduce completely new code or new features
• fix: changes that fix a bug (ideally you will additionally reference an issue if present)
• refactor: any code related change that is not a fix nor a feature
• docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
• build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
• ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
• chore: all changes to the repository that do not fit into any of the above categories

Please follow the following release checklist and convention.

• ❗ The changes for the new version have been added to theCHANGELOG.md file.
• ❗ The new version has been updated in thepolygon.ahk file.
• ❗ When cutting a release, please use tags with semver likev*.*.* format.

Use the following release note body for each release.

Please refer to[CHANGELOG.md](https://github.com/thesobercoder/polygon/blob/main/CHANGELOG.md) for details.

Licensed under theMIT license.