Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willianrod/ODeck
A free and open-source alternative to StreamDeck
https://github.com/willianrod/ODeck
gamming hacktoberfest streaming twitch
Last synced: about 1 month ago
JSON representation
A free and open-source alternative to StreamDeck
- Host: GitHub
- URL: https://github.com/willianrod/ODeck
- Owner: willianrod
- License: mit
- Created: 2022-02-19T01:38:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-17T18:20:45.000Z (7 months ago)
- Last Synced: 2024-07-24T22:10:23.822Z (about 2 months ago)
- Topics: gamming, hacktoberfest, streaming, twitch
- Language: TypeScript
- Homepage: https://odeck.app
- Size: 23.6 MB
- Stars: 384
- Watchers: 7
- Forks: 22
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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](https://play.google.com/store/apps/details?id=com.willianrod.odeck)
- [iOS](https://apps.apple.com/br/app/odeck/id6463042332)
## 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](https://github.com/willianrod/ODeck/releases), 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:
```bash
git clone https://github.com/willianrod/ODeck.git ODeck
cd ODeck
yarn install
```
## Starting Development
Launch the application in the development environment:
```bash
yarn start
```
## Packaging for Production
Package the application for your local platform:
```bash
yarn package
```
## Maintainers
- [Willian Rodrigues](https://github.com/WillianRod)
## License
Special thanks to [electron-react-boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) for providing an excellent template for creating Electron-based React applications.
MIT © [ODeck](https://github.com/WillianRod/ODeck)