luizcunha3 / odeck

A free and open-source alternative to StreamDeck

Elevate Your Streaming Experience with ODeck: The Open Source Alternative to StreamDeck

Read this README in other languages: English, Português, Español

---

About

ODeck is a versatile and powerful tool designed to enhance your live streams and boost productivity. Beyond catering to streamers of all levels, ODeck extends its functionality beyond streaming, allowing it to be adapted for various productivity tasks. Inspired by the idea of open-source, the "O" in ODeck underscores its commitment to transparency and customization. Give new purpose to your old, neglected smartphone by transforming it into a valuable tool.

Technology Stack

• Electron
• React
• React Native
• Socket.io

Platforms

ODeck is available on the following platforms:

Supported Platforms:

• Windows
• Mac

Mobile App:

• Android
• iOS

Unlimited Customization

ODeck offers a high degree of customization to meet your unique needs. Create custom devices with different key layouts, enabling precise control over your actions. Customize each key individually in the following ways:

• Change the background color
• Adjust the label text color
• Add background images to labels
• Hide labels to display only background images

How to Use

1. Download ODeck on your computer from the releases page, where all updates will be made available.
2. Install ODeck on your mobile device.
3. On your computer, create a new device, give it a name, and set the amount of keys vertically and horizontally.
4. Once created, click 'Select' to access the device customization screen and, in the upper left corner, click 'Pair Deck'.
5. A pop-up will appear; if necessary, select your computer's IP address.
6. Open the app on your mobile device and scan the QR code displayed on your computer.
7. Now you can customize your deck to suit your needs.

Features

ODeck has undergone extensive refinement, making it easy to add new features with minimal effort. Below is a list of the currently supported features:

Deck

• Navigate: Allows you to select and navigate between the app's pages.

• Back: Allows you to return to previously accessed pages.

System

• Run Application: Execute executable files on your computer.

• Shortcut: Record key combinations as shortcuts.

• Play Sound: Play .mp3 or .wav music files.

• URL: Open URLs with a single click.

Media

Control media playback on your computer with the following options:

• Play
• Pause
• Stop
• Previous
• Next
• Decrease Volume
• Increase Volume
• Mute

Contributing

Installation

Clone the repository and install dependencies:

git clone https://github.com/willianrod/ODeck.git ODeck
cd ODeck
yarn install

Starting Development

Launch the application in the development environment:

yarn start

Packaging for Production

Package the application for your local platform:

yarn package

Maintainers

• Willian Rodrigues

License

Special thanks to electron-react-boilerplate for providing an excellent template for creating Electron-based React applications.

MIT © ODeck