mirror of
https://github.com/nekename/OpenDeck.git
synced 2026-10-28 09:44:01 +00:00
Documentation updates
This commit is contained in:
ninjadev64 committed
1 parent
b0d3208fe7
commit
8ee5303090
5 files changed
+29
-16
No files matched your search
@@ -1,6 +1,8 @@
|
||||
# OpenDeck
|
||||
|
||||
OpenDeck is a desktop application for using stream controller devices like the Elgato Stream Deck. OpenDeck conforms to the [OpenAction](https://openaction.amankhanna.me/) API, which is cross-compatible with the Stream Deck SDK, allowing a wide range of pre-existing plugins to be used.
|
||||
|
||||
|
||||
OpenDeck is a desktop application for using stream controller devices like the Elgato Stream Deck. OpenDeck conforms to the [OpenAction](https://openaction.amankhanna.me/) API, which is cross-compatible with the Stream Deck SDK, allowing a wide range of plugins made for Elgato's first-party Windows and macOS software to be used.
|
||||
|
||||
OpenDeck supports ProntoKey, Elgato Stream Deck and some Ajazz hardware on all three major desktop platforms. If you would like to contribute support for additional hardware (e.g. Loupedeck) feel free to reach out on any of the support forums and make a pull request!
|
||||
|
||||
@@ -12,15 +14,19 @@ Special thanks go to the developers of [Tauri](https://github.com/tauri-apps/tau
|
||||
|
||||
### GNU+Linux
|
||||
|
||||
<a href="https://flathub.org/apps/me.amankhanna.opendeck">
|
||||
<img width="150" alt="Get it on Flathub" src="https://flathub.org/api/badge?locale=en-GB" />
|
||||
</a>
|
||||
|
||||
- Download the latest release from GitHub Releases.
|
||||
- You should avoid AppImage releases of OpenDeck as they tend to have problems (you should also just avoid AppImages in general).
|
||||
- For users of Arch-based distributions, there is the `opendeck` AUR package for the latest release, as well as the `opendeck-git` AUR package for the latest commit on the `main` branch of this repository.
|
||||
- Install OpenDeck using your package manager of choice.
|
||||
- If using Elgato hardware, install the appropriate udev subsystem rules from [here](https://raw.githubusercontent.com/streamduck-org/elgato-streamdeck/main/40-streamdeck.rules):
|
||||
- Install the appropriate udev subsystem rules from [here](https://raw.githubusercontent.com/streamduck-org/elgato-streamdeck/main/40-streamdeck.rules):
|
||||
- If you're using a `.deb` or `.rpm` release artifact, this file should be installed automatically.
|
||||
- Otherwise, download and copy it to the correct location with `sudo cp 40-streamdeck.rules /etc/udev/rules.d/`.
|
||||
- In both cases, you will need to reload your udev subsystem rules with `sudo udevadm control --reload-rules`.
|
||||
- If you intend to use plugins that are only compiled for Windows or macOS (which are the majority of plugins), you will need to have [Wine](https://www.winehq.org/) installed on your system.
|
||||
- If you intend to use plugins that are only compiled for Windows or macOS (which are the majority of plugins), you will need to have [Wine](https://www.winehq.org/) installed on your system. Some plugins may also depend on Wine Mono (which is sometimes, but not always included, in your distro's packaging of Wine).
|
||||
|
||||
### Windows
|
||||
|
||||
@@ -44,10 +50,12 @@ To edit an action's appearance, right-click on it and select "Edit" in the conte
|
||||
|
||||
To select another device, or to view or switch profiles, use the dropdowns in the top right corner. You can organise profiles into group-like folders by prefixing the profile name with the folder name and a forward slash.
|
||||
|
||||
To enable automatic launch on startup, the light theme, or to change the language plugins are localised in, open Settings. From here, you can also view information about your version of OpenDeck or open the configuration directory. To add or remove plugins, visit the Plugins tab.
|
||||
To enable automatic launch on startup, the light theme, to change the language plugins are localised in, or to modify other options, open Settings. From here, you can also view information about your version of OpenDeck or open the configuration directory. To add or remove plugins, visit the Plugins tab.
|
||||
|
||||
### Solutions to frequent problems
|
||||
### Troubleshooting
|
||||
|
||||
- Ensure you are running the latest version of OpenDeck, as well as recent versions of related software (e.g. Spotify or OBS, or your operating system and Wine).
|
||||
- Check the pinned [GitHub Issues](https://github.com/ninjadev64/OpenDeck/issues) to see if there's a fix for your problem already.
|
||||
- Check the OpenDeck log file for any important messages. This file should be included with any support request.
|
||||
- GNU+Linux: `~/.config/opendeck/logs/`
|
||||
- Windows: `%appdata%\opendeck\logs\`
|
||||
@@ -64,14 +72,14 @@ To enable automatic launch on startup, the light theme, or to change the languag
|
||||
|
||||
### Building from source / contributing
|
||||
|
||||
You'll need to ensure that all of the [prerequisites for building a Tauri application](https://tauri.app/v1/guides/getting-started/prerequisites) are satisfied to build OpenDeck, as well as making sure that [Deno](https://deno.com/) is installed. On GNU+Linux, you'll also need `libudev` installed for your distribution. You can then use `deno task tauri dev` and `deno task tauri build` to work with OpenDeck.
|
||||
You'll need to ensure that all of the [prerequisites for building a Tauri application](https://tauri.app/start/prerequisites) are satisfied to build OpenDeck, as well as making sure that [Deno](https://deno.com/) is installed. On GNU+Linux, you'll also need `libudev` installed for your distribution. You can then use `deno task tauri dev` and `deno task tauri build` to work with OpenDeck.
|
||||
|
||||
Before each commit, please ensure that all of the following are completed:
|
||||
- Rust code has been linted using `cargo clippy` and it discovers no violations
|
||||
- Rust code has been formatted using `cargo fmt`
|
||||
- TypeScript code has been linted using `deno lint` and it discovers no violations
|
||||
- Svelte code has been linted using `deno task check` and it discovers no violations
|
||||
- Frontend code has been formatted using `deno fmt`
|
||||
1. Rust code has been linted using `cargo clippy` and it discovers no violations
|
||||
2. Rust code has been formatted using `cargo fmt`
|
||||
3. TypeScript code has been linted using `deno lint` and it discovers no violations
|
||||
4. Svelte code has been linted using `deno task check` and it discovers no violations
|
||||
5. Frontend code has been formatted using `deno fmt --unstable-component`
|
||||
|
||||
Feel free to reach out on the support channels above for guidance when contributing!
|
||||
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "opendeck",
|
||||
"version": "2.2.0",
|
||||
"description": "A cross-platform desktop application for stream controller devices",
|
||||
"description": "Use stream controllers",
|
||||
"author": "ninjadev64",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"repository": "https://github.com/ninjadev64/OpenDeck",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
[package]
|
||||
name = "opendeck"
|
||||
version = "2.2.0"
|
||||
description = "A cross-platform desktop application for stream controller devices"
|
||||
description = "Use stream controllers"
|
||||
authors = [ "ninjadev64" ]
|
||||
license = "GPL-3.0-or-later"
|
||||
repository = "https://github.com/ninjadev64/OpenDeck"
|
||||
|
||||
@@ -3,8 +3,9 @@
|
||||
<id>opendeck</id>
|
||||
|
||||
<name>OpenDeck</name>
|
||||
<summary>A cross-platform desktop application for stream controller devices</summary>
|
||||
<summary>Use stream controllers</summary>
|
||||
<developer id="me.amankhanna"><name>Aman Khanna</name></developer>
|
||||
<launchable type="desktop-id">opendeck.desktop</launchable>
|
||||
|
||||
<url type="vcs-browser">https://github.com/ninjadev64/OpenDeck</url>
|
||||
<url type="homepage">https://github.com/ninjadev64/OpenDeck</url>
|
||||
@@ -24,7 +25,6 @@
|
||||
<p>Please note that you may need to install udev subsystem rules for your device to be detected. For more information, see the Installation section of the project README on GitHub.</p>
|
||||
</description>
|
||||
|
||||
<launchable type="desktop-id">opendeck.desktop</launchable>
|
||||
<screenshots>
|
||||
<screenshot type="default">
|
||||
<image>https://github.com/ninjadev64/OpenDeck/raw/2daaf68/.github/readme/mainmenu.png</image>
|
||||
@@ -37,6 +37,11 @@
|
||||
</screenshot>
|
||||
</screenshots>
|
||||
|
||||
<branding>
|
||||
<color type="primary" scheme_preference="light">#62a0ea</color>
|
||||
<color type="primary" scheme_preference="dark">#1a5fb4</color>
|
||||
</branding>
|
||||
|
||||
<releases>
|
||||
<release version="2.2.0" date="2024-10-14">
|
||||
<url type="details">https://github.com/ninjadev64/OpenDeck/releases/tag/v2.2.0</url>
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
}
|
||||
},
|
||||
"publisher": "ninjadev64",
|
||||
"shortDescription": "A cross-platform desktop application for stream controller devices",
|
||||
"shortDescription": "Use stream controllers",
|
||||
"longDescription": "OpenDeck is a desktop application for using stream controller devices like the Elgato Stream Deck. OpenDeck conforms to the OpenAction API, which is cross-compatible with the Stream Deck SDK, allowing a wide range of pre-existing plugins to be used.",
|
||||
"category": "Productivity",
|
||||
"icon": [
|
||||
|
||||
Reference in new issue
Block a user