https://github.com/spikehd/orbolay
Quick, small, native Discord overlay alternative for modded clients
https://github.com/spikehd/orbolay
dioxus discord freya overlay skia
Last synced: about 1 month ago
JSON representation
Quick, small, native Discord overlay alternative for modded clients
- Host: GitHub
- URL: https://github.com/spikehd/orbolay
- Owner: SpikeHD
- License: gpl-3.0
- Created: 2025-06-08T17:59:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-07T01:56:01.000Z (about 1 month ago)
- Last Synced: 2026-05-07T03:36:42.156Z (about 1 month ago)
- Topics: dioxus, discord, freya, overlay, skia
- Language: Rust
- Homepage:
- Size: 439 KB
- Stars: 80
- Watchers: 0
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Orbolay
Quick, small, native Discord overlay alternative
# Features
* Voice channel member list and status (who is speaking/muted/deafened/etc)
* Custom notifications
* Mute/deafen/disconnect controls
* Customizable layout
* Works with any official or modded client (including web!)
# Compatibility
* **Windows** - 10 and 11 both work, Windows 7 might work with kernel extensions
* **MacOS** - works, but cannot watch for keybinds (which means no voice controls)
* **Linux**
* **X11** - should work fine, you may need to add your user to the `input` group
* **Wayland** - technically works, you will want to use XWayland though (via `WAYLAND_DISPLAY="" orbolay`) and you may need to add your user to the `input` group
# Installation
## With Package Managers
> [!NOTE]
> Maintaining an `orbolay` package somewhere else? Let me know in an issue and I will add it here!
### Arch
```sh
yay -S orbolay-bin
```
### `cargo`
```sh
cargo install --locked --git https://github.com/SpikeHD/Orbolay.git
```
## Manual Installation
1. Download a [release](https://github.com/SpikeHD/Orbolay/releases) or the [latest actions build](https://github.com/SpikeHD/Orbolay/actions/workflows/build.yml).
2. Run the executable!
# How to Use
## With Official Clients
With Discord open:
1. Run the executable
2. Press Ctrl + ` to open the overlay and interact with voice controls
## With Modded Clients
With your client open:
1. Install a compatible bridge plugin ([Shelter](https://github.com/SpikeHD/shelter-plugins?tab=readme-ov-file#orbolay-bridge) / [Vencord](https://github.com/SpikeHD/vc-orbolay-bridge), also available on [Equicord](https://github.com/Equicord/Equicord))
2. Run the executable
3. Press Ctrl + ` to open the overlay and interact with voice controls
# Building
## Requirements
* Rust and Cargo
## Steps
1. Clone the repository
2. `cargo build --release`
3. Binaries will be in `target/release/`
# Special Thanks
* [Freya](https://github.com/marc2332/freya) - the main GUI library (that I may have fallen in love with)
* [Dioxus](https://dioxuslabs.com/) - framework for things like signals and `rsx!`
* [Discover](https://github.com/trigg/Discover) - a fantastic reference for some of the IPC-related stuff
* [docs.discord.food](https://docs.discord.food/) - incredible reference for undocumented Discord APIs
* Everyone else who contributes positively to the Rust ecosystem :)
# Contributing
PRs (especially for compatibility), polite issues, etc. are all welcome!