Skip to content

Commit

Permalink
Merge pull request #9 from niklasschroetler/niklasschroetler-patch-1
Browse files Browse the repository at this point in the history
Fixed typos, unclear sentence structure, etc. in README.md
  • Loading branch information
sebinside authored Mar 22, 2020
2 parents 014568c + b0d8538 commit 8ee14a6
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ The **AutoHotkey** (AHK) environment is a *powerful tool* to enhance your produc
Until now, you had only *two possible solutions*:

- **Exotic key combinations**, like... `CTRL + ALT + F13`. This solution is **fast**, but not very scalable. You might not remember, which hotkeys are still available and sometimes encounter bad side effects with your favorite software
- **Single AHK-scripts**, which you run directly from AHK or the explorer window. This solution is **scalable**, but how can you life with about *one second* delay, while the AHK-process is starting up?
- **Single AHK-scripts**, which you run directly from AHK or the explorer window. This solution is **scalable**, but how can you live with about *one second* of delay, while the AHK-process is starting up?

**Hotkeyless AutoHotkey** combines the best of both worlds. It's an easy way to expand your AHK-possibilites and both **fast** and **scalable**. But don't take my word for it, here are some numbers:
**Hotkeyless AutoHotkey** combines the best of both worlds. It's an easy way to expand your AHK-possibilities, both **fast** and **scalable**. But don't take my word for it, here are some numbers:

| Approach | Delay | Fast | Scalable |
| ----------------------- | :------- | :--: | :------: |
Expand All @@ -21,15 +21,15 @@ You can make your own *performance tests*. Just have a look at the `performance-

## Functionality

The **Hotkeyles AHK** script does launch a lightwight web server. It listens to the endpoint `localhost:42800/send/*` for http requests and redirects these to the `HotkeylessAHK.ahk` script. To be more precise, if you call `localhost:42800/send/HelloWorld`, the `HelloWorld()`-function inside the AHK-file is executed:
The **Hotkeyless AHK** script launches a lightweight web server. It listens to the endpoint `localhost:42800/send/*` for http requests and redirects them to the `HotkeylessAHK.ahk` script. To be more precise, if you call `localhost:42800/send/HelloWorld`, the `HelloWorld()`-function inside the AHK-file is executed:

```ahk
HelloWorld() {
MsgBox, Hello World
}
```

You can include your own AHK-scripts there and define custom functionality in a nice and clean way - without loosing too much performance. You can use your web browser, shortcuts or utility hardware like the [Stream Deck](https://www.elgato.com/gaming/stream-deck), like this:
Also, you can include your AHK-scripts and define custom functionality in a nice and clean way - without loosing too much performance. You can use your web browser, shortcuts or utility hardware like the [Stream Deck](https://www.elgato.com/gaming/stream-deck), like this:

![Stream Deck example](streamdeck.PNG)

Expand All @@ -41,11 +41,11 @@ You can include your own AHK-scripts there and define custom functionality in a
2. Install node. You can download it from https://nodejs.org/. Make sure that node is in the PATH-variable and available from the console. You can test this by executing `node -v`
3. Clone or download this repository. You can also just head over to [releases](https://github.com/sebinside/HotkeylessAHK/releases)
4. Open a console window and enter the `files` folder. Then, execute `npm install` to install all web server dependencies.
5. Start *Hotkeyless Authotkey* by executing the `HotkeylessAHK.ahk`-file.
6. Open your web browser and navigate to `http://localhost:42800/send/HelloWorld`. This should open a message dialog, triggered from the `HotkeylessAHK.ahk`-file.
5. Start *Hotkeyless AutoHotkey* by executing the `HotkeylessAHK.ahk`-file.
6. Open your web browser and navigate to `http://localhost:42800/send/HelloWorld`. This should open a message dialog, triggered by the `HotkeylessAHK.ahk`-file.
7. Now, you're ready to go.

*Troubleshooting*: If anything does not work, disable console window hiding by deleting line 3 and 4 in the `SetupServer()`-method in the `lib.ahk`-file and restart the process. This might give you more information.
*Troubleshooting*: If anything does not work, disable console window hiding by deleting lines 3 and 4 in the `SetupServer()`-method in the `lib.ahk`-file and restart the process. This might give you more information.

```
DllCall("AllocConsole")
Expand All @@ -54,7 +54,7 @@ WinHide % "ahk_id " DllCall("GetConsoleWindow", "ptr")

## Usage

Once installed, the usage of **Hotkeyless AutoHotkey** is easy: Write your own methods inside the `HotkeylessAHK.ahk`-file (or include other scripts) and call them with your web browser, the `curl`-console command, a stream deck, ...
Once installed, the usage of **Hotkeyless AutoHotkey** is easy: Write your methods inside the `HotkeylessAHK.ahk`-file (or include other scripts) and call them with your web browser, the `curl`-console command, a stream deck, ...

The endpoint is always the same: `http://localhost:42800/send/YourFunctionNameGoesHere`.

Expand All @@ -64,7 +64,7 @@ To terminate the running tool, call `http://localhost:42800/send/kill`.

This is yet another small tool to enhance the power of AHK. Some more links, you might find interesting:

- **[AHK2PremiereCEP](https://github.com/sebinside/AHK2PremiereCEP)**, another utility tool from me. It helps you connect authotkey with the Adobe Premiere CEP scripting environment. Very helpful tool for video production.
- **[AHK2PremiereCEP](https://github.com/sebinside/AHK2PremiereCEP)**, another utility tool from me which helps you connect AutoHotkey with the Adobe Premiere CEP scripting environment. A very helpful tool for video production.
- Taran Van Hemert, a macro specialist: https://www.youtube.com/user/TaranVH
- And my own twitch channel, where I develop with these techniques, sometimes: https://www.twitch.tv/skate702

Expand Down

0 comments on commit 8ee14a6

Please sign in to comment.