Added URL opening and README

Author: The-Jonsey

README.md

@@ -0,0 +1,59 @@
+# Streamdeckd  
+
+### Installation  
+  
+As this uses the [Elgato Stream Deck Library](https://www.npmjs.com/package/elgato-stream-deck), you will need to follow   
+the installation process for that, which includes taking steps to allow node to access the streamdeck via udev. these steps include:  
+  
+- create the file `/etc/udev/rules.d/50-elgato.rules` with the following config  
+```  
+SUBSYSTEM=="input", GROUP="input", MODE="0666"  
+SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0060", MODE:="666", GROUP="plugdev"  
+SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0063", MODE:="666", GROUP="plugdev"  
+SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666", GROUP="plugdev"  
+SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006d", MODE:="666", GROUP="plugdev"  
+```  
+  
+- run `sudo udevadm control --reload-rules` to reload the udev rules  
+  
+Then xdotool will be required to simulate keypresses, to install this run:  
+  
+#### Arch  
+  
+`sudo pacman -S xdotool`  
+  
+#### Debian based  
+  
+`sudo apt install xdotool`   
+
+
+### Configuration
+
+#### Manual configuration
+
+The configuration file streamdeckd uses is a JSON file found at `~/.streamdeck-config.json`
+
+An example config would be something like:
+
+```json
+{
+  "pages": [
+    [
+      {
+        "switch_page": 1,
+        "icon": "~/icon.png"
+      }
+    ]
+  ]
+}
+```
+
+The outer array is the list of pages, the inner array is the list of button on that page, with the buttons going in a right to left order.
+
+The actions you can have on a button are:
+
+- `command`: runs a native shell command, something like `notify-send "Hello World"`
+- `keybind`: simulates the indicated keybind via xdtotool
+- `url`: opens a url in your default browser via xdg
+- `brightness`: set the brightness of the streamdeck as a percentage
+- `switch_page`: change the active page on the streamdeck

config.go

@@ -7,6 +7,7 @@ type Pages [][] struct {
 	Keybind     string `json:"keybind,omitempty"`
 	Command     string `json:"command,omitempty"`
 	Brightness  *int    `json:"brightness,omitempty"`
+	Url 		string	`json:"url,omitempty"`
 }
 
 type Config struct {
@@ -21,4 +22,5 @@ type Key struct {
 	Keybind     string `json:"keybind,omitempty"`
 	Command     string `json:"command,omitempty"`
 	Brightness  *int    `json:"brightness,omitempty"`
+	Url 		string	`json:"url,omitempty"`
 }

main.go

@@ -122,6 +122,9 @@ func handleInput(key Key) {
 	if key.Brightness != nil {
 		_ = dev.SetBrightness(uint8(*key.Brightness))
 	}
+	if key.Url != "" {
+		runCommand("xdg-open " + key.Url)
+	}
 }
 
 func runCommand(command string) {