From ee39a9122987bb09533ba45c8f160965bd476a06 Mon Sep 17 00:00:00 2001 From: Jonatan Rek Date: Thu, 12 Sep 2024 20:06:56 +0200 Subject: [PATCH 1/2] Readme FIxes --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 55 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fd82140..753057d 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,26 @@ -## FakeDeck - Poor Man Macro Pad +# FakeDeck - Poor Man Macro Pad + +[![Github All Releases](https://img.shields.io/github/downloads/GamerClassN7/FakeDeck/total.svg)]() + 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) -### How to use it ? +## 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: -#### Helldivers 2 Macros +## Example Macros: +### Helldivers 2 Macros ```yaml - button: reinforce function: HelldiversTwoMacro parameters: - name: Key - value: "reinforce" + value: reinforce ``` ```yaml - button: strafing-run @@ -69,32 +72,73 @@ Just add desired macros to `configuration.yaml` and start the application, tahn - name: Key value: bomb ``` -#### Media Control Macros +### Media Control Macros ```yaml - button: mute function: MediaMacro parameters: - name: Key - value: "mute" + value: mute ``` ```yaml - button: previous function: MediaMacro parameters: - name: Key - value: "previous" + value: previous ``` ```yaml - button: play function: MediaMacro parameters: - name: Key - value: "play/pause" + value: play/pause ``` ```yaml - button: next function: MediaMacro parameters: - name: Key - value: "next" -``` \ No newline at end of file + value: next +``` +### FakeDeck UI Control Macros +```yaml +- button: full-screen + function: FakeDeckMacro + parameters: + - name: Key + value: full-screen +``` +```yaml +- button: set-page + function: FakeDeckMacro + parameters: + - name: Key + value: set-page + - name: PageId + value: {{page-id}} +``` +```yaml +- button: spacer + function: FakeDeckMacro + parameters: + - name: Key + value: spacer +``` +### Comon Macro Parameters +```yaml +... +parameters: +- name: Color + value: White #CSS friendly color +- name: Image + value: White #URL To Image (Local Path is not supported now) +... +``` +## Contributors + + + + +## Star History +[![Star History Chart](https://api.star-history.com/svg?repos=GamerClassN7/FakeDeck&type=Timeline)](https://star-history.com/#GamerClassN7/FakeDeck&Timeline)] \ No newline at end of file From 59673ec211c9c4a3893f56db6680d50d608794ca Mon Sep 17 00:00:00 2001 From: Jonatan Rek Date: Thu, 12 Sep 2024 20:09:44 +0200 Subject: [PATCH 2/2] REadme Style Fixes --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 753057d..3beae3a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@
- +
+ Github All Releases
# FakeDeck - Poor Man Macro Pad -[![Github All Releases](https://img.shields.io/github/downloads/GamerClassN7/FakeDeck/total.svg)]() - 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)