From c83c60d2b32fcef884e0cdaf08a859300ec6e865 Mon Sep 17 00:00:00 2001 From: Jonatan Rek Date: Thu, 12 Sep 2024 15:21:00 +0200 Subject: [PATCH] Readme Edits --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 71 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7626984..d1c30be 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,74 @@ ## FakeDeck - Poor Man Macro Pad -Creates simple webserver with buttons whitch can be opened on any device an can be used as macro pad/ keyboard +Creates simple webserver with buttons whitch can be opened on any device an can be used as macro pad/keyboard +![alt text](images/image.png) -![alt text](images/image.png) \ No newline at end of file +### How to use it ? + +Just add desired macros to `configuration.yaml` and start the application, tahn zou can load dashboard on any web capable device inside of your network. + +### Example Macros: + +```yaml +- button: reinforce + function: HelldiversTwoMacro + parameters: + - name: Key + value: "reinforce" +``` +```yaml +- button: strafing-run + function: HelldiversTwoMacro + parameters: + - name: Key + value: strafing-run +``` +```yaml +- button: airstrike + function: HelldiversTwoMacro + parameters: + - name: Key + value: airstrike +``` +```yaml +- button: cluster-bomb + function: HelldiversTwoMacro + parameters: + - name: Key + value: cluster-bomb +``` +```yaml +- button: napalm-airstrike + function: HelldiversTwoMacro + parameters: + - name: Key + value: napalm-airstrike +``` +```yaml +- button: smoke-strike + function: HelldiversTwoMacro + parameters: + - name: Key + value: smoke-strike +``` +```yaml +- button: rocket-pods + function: HelldiversTwoMacro + parameters: + - name: Key + value: rocket-pods +``` +```yaml +- button: bomb + function: HelldiversTwoMacro + parameters: + - name: Key + value: bomb +``` +```yaml +- button: mute + function: MediaMacro + parameters: + - name: Key + value: "mute" +``` \ No newline at end of file