Readme FIxes
This commit is contained in:
parent
2251de8ce9
commit
ee39a91229
64
README.md
64
README.md
@ -2,23 +2,26 @@
|
|||||||
<img src="images/logo.png" title="Logo">
|
<img src="images/logo.png" title="Logo">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## 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
|
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)
|
||||||
|
|
||||||
### 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.
|
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:
|
## Example Macros:
|
||||||
#### Helldivers 2 Macros
|
### Helldivers 2 Macros
|
||||||
```yaml
|
```yaml
|
||||||
- button: reinforce
|
- button: reinforce
|
||||||
function: HelldiversTwoMacro
|
function: HelldiversTwoMacro
|
||||||
parameters:
|
parameters:
|
||||||
- name: Key
|
- name: Key
|
||||||
value: "reinforce"
|
value: reinforce
|
||||||
```
|
```
|
||||||
```yaml
|
```yaml
|
||||||
- button: strafing-run
|
- button: strafing-run
|
||||||
@ -69,32 +72,73 @@ Just add desired macros to `configuration.yaml` and start the application, tahn
|
|||||||
- name: Key
|
- name: Key
|
||||||
value: bomb
|
value: bomb
|
||||||
```
|
```
|
||||||
#### Media Control Macros
|
### Media Control Macros
|
||||||
```yaml
|
```yaml
|
||||||
- button: mute
|
- button: mute
|
||||||
function: MediaMacro
|
function: MediaMacro
|
||||||
parameters:
|
parameters:
|
||||||
- name: Key
|
- name: Key
|
||||||
value: "mute"
|
value: mute
|
||||||
```
|
```
|
||||||
```yaml
|
```yaml
|
||||||
- button: previous
|
- button: previous
|
||||||
function: MediaMacro
|
function: MediaMacro
|
||||||
parameters:
|
parameters:
|
||||||
- name: Key
|
- name: Key
|
||||||
value: "previous"
|
value: previous
|
||||||
```
|
```
|
||||||
```yaml
|
```yaml
|
||||||
- button: play
|
- button: play
|
||||||
function: MediaMacro
|
function: MediaMacro
|
||||||
parameters:
|
parameters:
|
||||||
- name: Key
|
- name: Key
|
||||||
value: "play/pause"
|
value: play/pause
|
||||||
```
|
```
|
||||||
```yaml
|
```yaml
|
||||||
- button: next
|
- button: next
|
||||||
function: MediaMacro
|
function: MediaMacro
|
||||||
parameters:
|
parameters:
|
||||||
- name: Key
|
- name: Key
|
||||||
value: "next"
|
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
|
||||||
|
<a href="https://github.com/GamerClassN7/FakeDeck/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=GamerClassN7/FakeDeck" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
## Star History
|
||||||
|
[![Star History Chart](https://api.star-history.com/svg?repos=GamerClassN7/FakeDeck&type=Timeline)](https://star-history.com/#GamerClassN7/FakeDeck&Timeline)]
|
Loading…
Reference in New Issue
Block a user