mirror of
https://codeberg.org/waydeer/layer-shika.git
synced 2025-12-02 22:35:55 +00:00
53 lines
2.5 KiB
Markdown
53 lines
2.5 KiB
Markdown
# layer-shika
|
|
|
|
[Main repo](https://codeberg.org/waydeer/layer-shika) | [Mirror](https://git.dren.dog/waydeer/layer-shika) | [Temp mirror (github)](https://github.com/waydeerwm/layer-shika)
|
|
|
|
## ⚠️ WORK IN PROGRESS ⚠️
|
|
|
|
Oh deer! 🦌 You've stumbled upon `layer-shika`, a rust library crate that provides a layer shell implementation for wayland compositors, using slint for the GUI. It allows you to create overlay windows and panels or bars that integrate seamlessly with wayland-based desktop environments.
|
|
|
|
Please note that this library is currently in early development and is not yet ready for production use.
|
|
|
|
## Current Status
|
|
|
|
- **Architecture**: Clean hexagonal architecture with domain, adapters, and composition layers
|
|
- **Rendering**: EGL context management with `femtovg` renderer integration
|
|
- **Wayland**: Comprehensive layer shell protocol support using `smithay-client-toolkit`
|
|
- Output management and configuration
|
|
- Surface lifecycle management
|
|
- Basic xdg popup support (currently with double creation workaround, due dependencies limitations)
|
|
- Event handling system
|
|
- **UI Integration**: Slint integration layer with custom rendering backend
|
|
- **Documentation**: Work in progress
|
|
- **Examples**: Coming soon (examples directory prepared)
|
|
|
|
**What's Working:**
|
|
|
|
- EGL context creation and management
|
|
- Wayland layer shell surface creation
|
|
- XDG popup support (with some limitations, new window and resizing needed to work with current workaround)
|
|
- Basic rendering with femtovg
|
|
- Output detection and management
|
|
- Event handling framework
|
|
|
|
**Known Limitations:**
|
|
|
|
- Not all features are fully implemented or tested
|
|
- API is still unstable and may change
|
|
- Examples and comprehensive documentation pending
|
|
|
|
It's recommended to wait for a stable release before using this library in production projects. Development is trying to be as fast as a running skippy deer!
|
|
|
|
## Usage
|
|
|
|
Examples and usage instructions are coming soon. Hoping that they will not be too deer-ifying, like the current state of this library. If you want to use it now, use this repo as dependency instead of crates.io outdated versions.
|
|
|
|
## First Stable Release
|
|
|
|
It aim to have the first stable release by the end of 2025, with a focus on core functionality and API stability.
|
|
|
|
Stay tuned!
|
|
|
|
## Contributing
|
|
|
|
As the library is in a very early stage, it's recommended to open an issue to discuss ideas or proposed changes before submitting contributions. The project doesn't bite, it's not that kind of deer!
|