Add documentation for key mapping in configuration files

[izosozi]

Is your feature request related to a problem? Please describe.

I'm unable to find documentation on the formatting and labels for config file key mapping, though enough was implied in the sample config file for me to generally figure it out. However, this might be more frustrating for those less familiar with YAML, data types, or typical naming patterns for non-character keys.

Describe the solution you'd like

Clear documentation of the labels and format expected for key mapping in the config file. This would be included or linked to in the sample config file and/or the configuration file docs.

This would include:

• Clarification of which keys are represented by labels rather than characters (for example, some other software would use semicolon, but Amethyst uses ";")
• Characters that require wrapping in quotes (period, comma, semicolon, minus, numbers, etc. but not a-z)
• Correct labels for non-character keys (delete vs backspace, enter vs return, left vs left-arrow vs arrow-left, esc vs escape, etc.)
• General guidance on limitations, edge cases, interpretation of unusual characters

Describe alternatives you've considered
More verbose error messages (compared to the generic "Error loading configuration" dialog) could address this, but would probably be less effective and more complex than writing documentation.

Thanks for your work on this project!

EDIT: Some of this is indeed explained in the sample config file, but it might be useful to expand on this.

# Commands:
# special key values
# space
# enter
# up
# right
# down
# left

# special characters require quotes
# '.'
# ','

[ianyh]

Seems like reasonable stuff to clarify.