eworc778/kico-r4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README.MD to point to new syntax documentation.

Browse Source
This commit is contained in:
eworc778 2025-08-25 21:49:29 +01:00
parent 470b4c2333
commit eb8db0cb1b
2 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.MD
View File

@ -5,7 +5,7 @@ Kico is an open source macro pad, powered by RP2040.
This repository inicludes the code for the RP2040, pinouts, and example macro files. This repository inicludes the code for the RP2040, pinouts, and example macro files.
Syntax for the macro engine is visible in `code.py`. Syntax for the macro engine is visible in [SYNTAX.MD](SYNTAX.MD).
> This project is licensed under the MIT license. For more information see `LICENSE`. > This project is licensed under the MIT license. For more information see `LICENSE`.

58
SYNTAX.MD Normal file
View File

@ -0,0 +1,58 @@
Kico macro file syntax:
> Macro files must be placed in the 'macros' folder in the pico's internal storage.
> Macro files must be saved as '.mcr' files.
The Kico is capable of typing most characters.
Each line in the file is read as a single instruction.
- "\<string>": Types out the string inside the quotes. Allows most characters, exluding '\\' and '/'
- #: Used at the start of a line to mark a it as a comment. Comments are not executed, but are still displayed.
- LCD_SHOW "\<string>": Displays a string on the top line of the LCD.
- WAIT \<duration>: Pauses execution for the specified interval. Accepts either an integer or a float.
- HOLD: Starts reading up to 6 of the next keys as a combination.
- RELEASE: Releases a held combination of up to 6 keys.
## Key aliases:
> Aliases must be entered on their own line, without quotes.
- super: Key commonly marked as with a Windows Icon on most keyboards.
- windows: Key commonly marked as Windows Icon on most keyboards.
- enter: Enter key, sometimes marked as return. Mainly used for newlines.
- escape: Key commonly marked as "Esc" on most keyboards.
- tab: A tab character.f<1-24>: Function keys one through 24.
- ctrl: Left control key.
- shift: Left shift key. Can be used in hold combinations to capitalise a specific key.
- downarrow: Down arrow key.
- uparrow: Up arrow key.
- leftarrow: Left arrow key.
- rightarrow: Right arrow key.
- space: A space character (" ").
- capslock: Caps lock key, is toggled when sent.
- delete: Delete key.
- forwardslash: A "/" character.
- backslash: A "\\" character.
- backspace: The backspace key.