f385e46927
* docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
18 lines
933 B
Markdown
18 lines
933 B
Markdown
#### [`dllmain.cpp`](/src/modules/shortcut_guide/dllmain.cpp)
|
||
Contains DLL boilerplate code.
|
||
|
||
#### [`shortcut_guide.cpp`](/src/modules/shortcut_guide/shortcut_guide.cpp)
|
||
Contains the module interface code. It initializes the settings values and the keyboard event listener.
|
||
|
||
#### [`overlay_window.cpp`](/src/modules/shortcut_guide/overlay_window.cpp)
|
||
Contains the code for loading the SVGs, creating and rendering of the overlay window.
|
||
|
||
#### [`keyboard_state.cpp`](/src/modules/shortcut_guide/keyboard_state.cpp)
|
||
Contains helper methods for checking the current state of the keyboard.
|
||
|
||
#### [`target_state.cpp`](/src/modules/shortcut_guide/target_state.cpp)
|
||
State machine that handles the keyboard events. It’s responsible for deciding when to show the overlay, when to suppress the Start menu (if the overlay is displayed long enough), etc.
|
||
|
||
#### [`trace.cpp`](/src/modules/shortcut_guide/trace.cpp)
|
||
Contains code for telemetry.
|