Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dend committed Jul 21, 2021
1 parent 323974e commit f0e5e59
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<br>
</div>

The goal of this project is to create open, lightweight, and accessible tooling to manage a Stream Deck device without worrying about [random code looking over your machine](https://twitter.com/DennisCode/status/1401230392527523856).


## How It Works

Expand Down Expand Up @@ -44,3 +44,25 @@ The following arguments are used, and are required:
| `--profile` or `-p` | The name of the profile to be used. If no profile with a given name exists, a new one will be created. |

The created profile will be located in `%LOCALAPPDATA%\DenDev\{PROFILE_NAME}`. The settings are stored in a `profile.json` file within the profile folder.

## FAQ

### Why was this project created?

I was fiddling with the default Stream Deck software, and realized that it [was constantly scanning my registry and process tree](https://twitter.com/DennisCode/status/1401230392527523856). According to Elgato support, this is necessary for [Smart Profiles](https://help.elgato.com/hc/en-us/articles/360053419071-Elgato-Stream-Deck-Smart-Profiles); however, the process monitoring occurs even when Smart Profiles are not configured. While the feature itself is nice, I wasn't too comfortable with some software constantly monitoring what I run without a way to disable that, so I decided to tinker with the device and see if I can figure out how to write my own software that manages the Stream Deck device.

### Is this official/endorsed by Elgato?

No - not in any capacity. Use at your own leisure and risk.

### Where can I go to read more about the project?

This repository generally should be a good starting point, but you can also go to [https://deck.surf](https://deck.surf) for latest links and relevant information.

### Can I run this on Linux/macOS?

Not yet - I am still exploring the best way to make this tooling reliably work on Windows. Once that is done, I would love to make this also work on macOS and Linux.

### Is there a GUI management app for this?

Not yet - it's just a CLI and a .NET SDK. In the future, I expect to also create a more visual approach to managing the content, that is easier for folks that don't want to fiddle with the terminal.
Binary file modified images/logo.afphoto
Binary file not shown.
Binary file modified images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/piglet.ico
Binary file not shown.

0 comments on commit f0e5e59

Please sign in to comment.