Skip to content

zEhmsy/umpb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn

Logo

UMPB

A frameless, always‑on‑top overlay (Python + PySide6) that acts like a virtual Stream Deck. Toggle it globally, add shortcuts or apps on the fly, and keep your layout between sessions.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Detailed Function Explanation
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project

UMPB (Universal Mini Palette Board) is a versatile developer tool that manages overlay interfaces on the Steam Deck platform, enabling intuitive control and interaction within applications. It facilitates the creation of customizable, persistent overlays that enhance user accessibility and control.

Why umpb?

This project empowers developers to build seamless overlay experiences that bridge system operations with user-facing interfaces. The core features include:

  • 🎨 🖥️ Overlay Management: Handles display and interaction of icons, buttons, and dialogs within the graphical environment.
  • 🔑 🔄 Layout Persistence: Saves and loads custom overlay configurations for a consistent user experience.
  • ⚙️ 📝 Shortcut & Keystroke Automation: Simplifies quick access to functions through customizable shortcuts and input simulation.
  • 🌐 🌟 Cross-Platform Input Dispatching: Ensures responsive control across different systems and input methods.
  • 🚀 🔧 User Interaction Enhancement: Improves accessibility and control, making overlay management straightforward for developers and users alike.

Screenshot

screenshot

Built With

  • PySide6 – GUI Qt for Python 6
  • pynput – global keyboard listener

Getting Started

Prerequisites

  • Python ≥ 3.10
  • macOS, Windows o Linux (X11/Wayland)

Installation

# clone & set‑up venv
git clone https://github.com/USERNAME/umpb.git
cd umpb
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python deck_overlay.py

(back to top)


Usage

Toggle overlay: ⌘/Ctrl + ⇧ + D

Trigger tile 1‑8: ⌥ + 1‑8

Edit‑mode: click on the header icon

Layout saved in ~/.umpb_layout.json and reload at the start.

Detailed Function Explanation

send_keystroke(combo: str)

Cross-platform send combination ("ctrl+c", "cmd+v" ...) using pynput. On macOS it automatically converts ctrl to cmd if needed.

_prompt_new_shortcut()

Opens a dialog asking whether to create an App link (file picker) or Key combination (QKeySequenceEdit widget). Validates input, instantiates Shortcut, refreshes page and saves layout.

_load_layout() / _save_layout()

Serialize the pages array into JSON under ~/.umpb_layout.json. Call on every change and in closeEvent for immediate persistence.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

If you want to support me or you appraciate the project you can: "Buy Me A Coffee"

For now, this project serves as a functional demonstration of digest authentication implementation on Arduino boards with Ethernet connectivity, with potential future iterations to support additional hardware platforms. If yu like it! Leave a star ⭐️

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Giuseppe Tururro - WHOAMI? - info.g.turturro@gmail.com

Project Link: https://github.com/zEhmsy/umpb

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages