732c7aef5c
Although this is used in apps that use `tokio`, if we're going to support `smol`, this seems suboptimal to require. This assumes the function will be called by a tokio executor if the `tokio` feature is used. Otherwise it can be spawned from any executor. That should be consistent with everything else. This fails to compile without either the `tokio` or `smol` feature. This seems reasonable, since `zbus` also fails to compile in that case. |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| cosmic-config | ||
| cosmic-config-derive | ||
| cosmic-theme | ||
| examples | ||
| iced@fa817c704d | ||
| res | ||
| src | ||
| .gitignore | ||
| .gitmodules | ||
| Cargo.toml | ||
| config.toml | ||
| justfile | ||
| LICENSE | ||
| README.md | ||
LIBCOSMIC
A platform toolkit based on iced which provides the building blocks for developing the future COSMIC desktop environment. Applications and applets alike are equally supported targets of Libcosmic. Applets integrate directly with COSMIC's interface as shell components, which was made possible by the Layer Shell protocol of Wayland.
Building
Libcosmic is written entirely in Rust, with minimal dependence on system libraries. On Pop!_OS, the following dependencies are all that's necessary compile the cosmic library:
sudo apt install cargo cmake just libexpat1-dev libfontconfig-dev libfreetype-dev pkg-config
Some examples are included in the examples directory to to kickstart your COSMIC adventure. To run them, you need to clone the repository with the following commands:
git clone https://github.com/pop-os/libcosmic
cd libcosmic
git submodule update --init --recursive
If you have already cloned the repository, run these to sync with the latest updates:
git fetch origin
git checkout master
git reset --hard origin/master
git submodule update --init --recursive
The examples may then be run by their cargo project names, such as just run cosmic-design-demo.
To create a new COSMIC project, use cargo new {{name_of_project}} to create a new
project workspace, edit the Cargo.toml contained within, and add this to begin.
[workspace.dependencies.libcosmic]
git = "https://github.com/pop-os/libcosmic"
default-features = false
features = ["wayland", "tokio"]
Alternatively, to create a new package after running cargo new {{name_of_project}},
edit the Cargo.toml within, and edit the dependencies section to look like this.
[dependencies]
libcosmic = { git = "https://github.com/pop-os/libcosmic", default-features = false,
features = ["wayland", "tokio"] }
Cargo Features
Available cargo features to choose from:
a11y: Experimental accessibility support.animated-image: Enables animated images from the image crate.debug: Enables addtional debugging features.smol: Uses smol as the preferred async runtime.- Conflicts with
tokio
- Conflicts with
tokio: Uses tokio as the preferred async runtime.- If unset, the default executor defined by iced will be used.
- Conflicts with
smol
wayland: Wayland-compatible client windows.- Conflicts with
winit
- Conflicts with
winit: Cross-platform and X11 client window support- Conflicts with
wayland
- Conflicts with
wgpu: GPU accelerated rendering with WGPU.- By default, softbuffer is used for software rendering.
xdg-portal: Enables XDG portal dialog integrations.
Project Showcase
- COSMIC App Library
- COSMIC Applets
- COSMIC Launcher
- COSMIC Notifications
- COSMIC Panel
- COSMIC Text Editor
- COSMIC Settings
Documentation
Documentation can be found here.
Licence
Licensed under the Mozilla Public License 2.0.