feat: toggle script

Toggle the script, useful for typing situations.
anntnzrb · Feb 3, 2023 · 8d5903e · 8d5903e
1 parent 1e248c5
commit 8d5903e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -25,12 +25,12 @@ Your feedback will help to make this application a better tool for players.
 By default, the game only offers an option called **Backstep, Dodge Roll, Dash**
 which overloads **3** features into a single bind (Sprint, Roll, Backstep). There are also other useful binds.
 
-| **Feature**      | **Description**                                                                   | **Key**       |
-|------------------|-----------------------------------------------------------------------------------|---------------|
-| **Sprinting**    | Unmodified behavior. Hold the key to sprint.                                      | `LAlt` (hold) |
-| **Rolling**      | Instantly roll. Rolling is done as soon the button is pressed, not when released. | `Spacebar`    |
-| **Backstepping** | Perform a backstep regardless of player movement.                                 | `Ctrl`        |
-| **Show Status**  | Show the "Status" screen with a single button press.                              | `u`           |
+| **Feature**      | **Description**                                                                  | **Key**       |
+|------------------|----------------------------------------------------------------------------------|---------------|
+| **Sprinting**    | Unmodified behavior. Hold the key to sprint                                      | `LAlt` (hold) |
+| **Rolling**      | Instantly roll. Rolling is done as soon the button is pressed, not when released | `Spacebar`    |
+| **Backstepping** | Perform a backstep regardless of player movement                                 | `Ctrl`        |
+| **Show Status**  | Show the "Status" screen with a single button press                              | `u`           |
 
 ### Quick Features
 
@@ -39,9 +39,9 @@ and convenient access.
 
 | **Feature**          | **Description**                                         | **Use Case**                         | **Key**        |
 |----------------------|---------------------------------------------------------|--------------------------------------|----------------|
-| **Quick MainMenu**   | Instantly go to the game's main menu.                   | - Aggro removing<br>- Area reloading | `LShift + ESC` |
-| **Quick RoundTable** | Instantly go the Round Table Hold.                      |                                      | `LShift + g`   |
-| **Pause**            | Pauses the game. Accomplished by entering some sub-menu | - Pause the game enirely.            | `Ctrl + ESC`   |
+| **Quick MainMenu**   | Instantly go to the game's main menu                    | - Aggro removing<br>- Area reloading | `LShift + ESC` |
+| **Quick RoundTable** | Instantly go the Round Table Hold                       |                                      | `LShift + g`   |
+| **Pause**            | Pauses the game. Accomplished by entering some sub-menu | - Pause the game enirely             | `Ctrl + ESC`   |
 | **Spinner**          | Spins the player clock-wise                             |                                      | `v`            |
 
 | **Gesture**           | **Key** |
@@ -53,6 +53,12 @@ and convenient access.
 | **#5 (Bottom Left)**  | `k`     |
 | **#6 (Bottom Right)** | `l`     |
 
+### Miscellaneous
+
+| **Feature**       | **Description**                           | **Key**      | **Notes**                   |
+|-------------------|-------------------------------------------|--------------|-----------------------------|
+| **Toggle Script** | Toggles the whole script. Used for typing | `RCtrl + F9` | This bind cannot be changed |
+
 ## Installation
 
 1. Download and install [AutoHotkey v2](https://www.autohotkey.com/v2/) from the
@@ -77,7 +83,7 @@ updated.
 
 **A**:
 > There's a `config.ini` file in the root of the program. In there you may
-change the binding to your liking, read the top header comment for link to
+change the bindings to your liking, read the top header comment for a link to
 [AHK's Key's List](https://www.autohotkey.com/docs/v2/KeyList.htm).
 
 ## Goals
@@ -98,9 +104,10 @@ may be subject to the terms and conditions set forth by the game's publisher.
 This project was created as a way for me to learn the AHK v2 language
 and experiment with its capabilities. The end goal is to provide a helpful and
 convenient tool for players, there may be areas for improvement. I am open to
-collaboration, submitting Pull Request & Issues is available.
+collaboration; submitting Pull Requests & Issues is available.
 
-This application is a third-party program and is in no way affiliated with Elden Ring, FromSoftware, or Bandai Namco.
+This application is a third-party program and is in no way affiliated with
+Elden Ring, FromSoftware, or Bandai Namco.
 
 ## Copying
 

diff --git a/main.ahk b/main.ahk
@@ -57,4 +57,9 @@ Hotkey ER_KEY_QK_GESTURE2, qkGesture2
 Hotkey ER_KEY_QK_GESTURE3, qkGesture3
 Hotkey ER_KEY_QK_GESTURE4, qkGesture4
 Hotkey ER_KEY_QK_GESTURE5, qkGesture5
-Hotkey ER_KEY_QK_GESTURE6, qkGesture6
+Hotkey ER_KEY_QK_GESTURE6, qkGesture6
+
+; System
+#SuspendExempt
+>^F9::Suspend(-1)
+#SuspendExempt False
diff --git a/src/keys.ahk b/src/keys.ahk
@@ -13,16 +13,16 @@ global ER_KEY_ROLL      := IniRead(configFile, "Keys", "ER_KEY_ROLL")
 global ER_KEY_ROLL_MENU := IniRead(configFile, "Keys", "ER_KEY_ROLL_MENU")
 global ER_KEY_BACKSTEP  := IniRead(configFile, "Keys", "ER_KEY_BACKSTEP")
 
-global ER_KEY_QK_ROUNDTABLE  := IniRead(configFile, "Keys", "ER_KEY_QK_ROUNDTABLE")
-global ER_KEY_QK_MAINMENU    := IniRead(configFile, "Keys", "ER_KEY_QK_MAINMENU")
-global ER_KEY_QK_STATUS      := IniRead(configFile, "Keys", "ER_KEY_QK_STATUS")
-global ER_KEY_PAUSEGAME      := IniRead(configFile, "Keys", "ER_KEY_PAUSEGAME")
-global ER_KEY_SPINNER        := IniRead(configFile, "Keys", "ER_KEY_SPINNER")
+global ER_KEY_QK_ROUNDTABLE := IniRead(configFile, "Keys", "ER_KEY_QK_ROUNDTABLE")
+global ER_KEY_QK_MAINMENU   := IniRead(configFile, "Keys", "ER_KEY_QK_MAINMENU")
+global ER_KEY_QK_STATUS     := IniRead(configFile, "Keys", "ER_KEY_QK_STATUS")
+global ER_KEY_PAUSEGAME     := IniRead(configFile, "Keys", "ER_KEY_PAUSEGAME")
+global ER_KEY_SPINNER       := IniRead(configFile, "Keys", "ER_KEY_SPINNER")
 
 ; Gestures
-global ER_KEY_QK_GESTURE1  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE1")
-global ER_KEY_QK_GESTURE2  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE2")
-global ER_KEY_QK_GESTURE3  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE3")
-global ER_KEY_QK_GESTURE4  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE4")
-global ER_KEY_QK_GESTURE5  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE5")
-global ER_KEY_QK_GESTURE6  := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE6")
+global ER_KEY_QK_GESTURE1 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE1")
+global ER_KEY_QK_GESTURE2 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE2")
+global ER_KEY_QK_GESTURE3 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE3")
+global ER_KEY_QK_GESTURE4 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE4")
+global ER_KEY_QK_GESTURE5 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE5")
+global ER_KEY_QK_GESTURE6 := IniRead(configFile, "Keys", "ER_KEY_QK_GESTURE6")