Troubleshoot

P1: SnapKey not working in specific games?

Game Compatibility & SnapKey

SnapKey was not created to work with a "specific" game.

Some game engines use custom or non-standard input handling, which can sometimes cause conflicts or unexpected behavior. For example, SnapKeys’ input handling via the Windows API might interfere with the game’s input methods, leading to issues where the game does not correctly recognize inputs.

Based on observation, these issues predominantly occur with older or custom in-house engines.

Some games with a launcher, such as Valorant and GTA V, require SnapKey to be RUN AS ADMINISTRATOR in order to function properly.

For a list of known compatible and incompatible games, please refer to the Compatibility List.

P2: Restore Config File

SOLUTION 1: Reset to Default Configuration (Version 1.1.6 and Later)

For versions 1.1.6 and later, you can reset to the default configuration as follows:

1. Delete Config File:

   • Remove the config.cfg file from the SnapKey directory.

   

2. Restart SnapKey:

   • Launch SnapKey.exe. A new default config.cfg file will be automatically created.

SOLUTION 2: Download and Replace Configuration File

Download a Fresh Config File: If changes to key values don’t resolve the issue, download the default configuration file:

• Download vanilla config.cfg

Replace Existing File: Replace the current config.cfg file in the SnapKey directory with the downloaded one.

---

P3: Key Configuration Issues

If you're experiencing issues with key mappings in your SnapKey setup, follow this guide to identify and resolve the problem.

---

1. Verify Keyboard Layout

Confirm Layout:

• QWERTZ/QWERTY: Generally, no additional configuration needed.
• AZERTY: Requires specific adjustments in the configuration file.
• DVORAK: Requires specific adjustments in the configuration file.
• COLEMAK: Requires specific adjustments in the configuration file.

2. Verify Key Assignments

Check Key Assignments: Ensure your keys are correctly set in the configuration file.

By default:

• key1=65 (maps to ASCII value 'A')
• key2=68 (maps to ASCII value 'D')
• key3=83 (maps to ASCII value 'S')
• key4=87 (maps to ASCII value 'W')

Verify these values match the ASCII table in your configuration file.

Adjust Based on Keyboard Layout:

• QWERTZ and QWERTY Layouts: Default values should work.

  • QWERTZ: key1=65, key2=68, key3=83, key4=87
  • QWERTY: key1=65, key2=68, key3=83, key4=87

• AZERTY Layout: Update key1-4 values as follows:

  • AZERTY: key1=81, key2=68, key3=90, key4=83

---

3. Test Your Setup

Online Testing: Verify your key configuration with:

• MultiKeyDisplay Online Tool

Explore Similar Issues: For more insights, check:

• Issue #9

---

By following this structured approach, you can troubleshoot key mapping issues and manage your configuration file effectively.

---

P4: Error - Failed to Restore Config from Backup

• Issue: Either the meta folder is missing or the snapkey.backup file is missing from the meta folder.
• Solution:
  • Download the original backup.snapkey file from this link.
  • Place the file in the meta folder. If the meta folder does not exist, create it in the main SnapKey directory.

P5: Dublicate Keys in the Config File

When you encounter the error "The config file contains duplicate keys across various groups", it usually means that the configuration file you're working with has repeated or conflicting key-value pairs. To resolve this, you need to open the configuration (config.cfg) file and check for the following:

• Duplicate key codes within the same group.
• Duplicate key codes across multiple groups (e.g., the same key code being assigned to multiple keys within the same group).

Example Before Fix:

[Group]
key1=65
key2=65   ; Duplicate value - must change

[Group]
key3=83
key4=87

Example After Fix:

[Group]
key1=65
key2=66   ; Fixed, unique value for key2

[Group]
key3=83
key4=87

P6: Keyboard Ghosting (Hardware Limitation)

Since SnapKey is designed to work with all keyboards, it's important to note that not every keyboard will support its full functionality. Some inexpensive keyboards have a limitation that only allows 2 or 3 keys to be pressed simultaneously.

This is called Keyboard ghosting. Keyboard ghosting refers to an issue where certain combinations of keys pressed simultaneously are not recognized by the keyboard. When this occurs, the keyboard fails to register one or more of the key presses in the combination

Ghosting happens because of limitations in the keyboard's hardware or matrix design. Keyboards are designed with a matrix of circuits that register key presses, and some combinations of keys share the same electrical pathways. When multiple keys in a specific area of the matrix are pressed simultaneously, the keyboard may not be able to differentiate between them due to the shared pathways, resulting in missed key presses or incorrect key registrations.

Image from: https://keyboardtester.io/key-rollover-test/

Here are a few examples of key combinations and how ghosting might affect them:

1. W + A + S + D + CTRL

   • Possible Issue: Some keyboards might struggle with this combination, leading to one or more keys not registering correctly. Typically, you might lose the registration of one of the directional keys (W, A, S, or D) or even the CTRL key, depending on the keyboard's design.

2. W + A + CTRL

   • Possible Issue: This combination is often manageable for most keyboards, but if ghosting occurs, you might find that one of the keys, like A or CTRL, may not register. However, many keyboards handle this without issue.

3. S + D + CTRL

   • Possible Issue: This combination is less likely to cause ghosting on most modern keyboards, but older or lower-quality keyboards might still have trouble with it, potentially canceling one of the keys.

4. W + D + CTRL

   • Possible Issue: Similar to the previous combinations, modern keyboards generally handle this well, but some might still face issues with ghosting, leading to one key not being registered.

The actual key that gets canceled or fails to register depends on the keyboard's matrix design and its anti-ghosting capabilities. Higher-end gaming keyboards with anti-ghosting features and full N-key rollover (which allows all keys to be pressed simultaneously without any issues) are less likely to experience ghosting problems with these combinations.

1. Hardware Limitations
2. Keyboard Matrix Design:

• Most ghosting issues are related to the keyboard’s hardware, specifically its matrix design. In a traditional keyboard matrix, certain key combinations may cause electrical conflicts, resulting in some keys not being registered.