Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Schneegans/Desktop-Cube
🧊 Indulge in nostalgia with useless 3D effects.
https://github.com/Schneegans/Desktop-Cube
3d-desktop gjs gnome gnome-shell gnome-shell-extension
Last synced: about 2 months ago
JSON representation
🧊 Indulge in nostalgia with useless 3D effects.
- Host: GitHub
- URL: https://github.com/Schneegans/Desktop-Cube
- Owner: Schneegans
- License: gpl-3.0
- Created: 2021-12-06T18:43:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T18:41:24.000Z (2 months ago)
- Last Synced: 2024-04-12T00:02:36.082Z (2 months ago)
- Topics: 3d-desktop, gjs, gnome, gnome-shell, gnome-shell-extension
- Language: JavaScript
- Homepage:
- Size: 14 MB
- Stars: 587
- Watchers: 15
- Forks: 20
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-gnome - Desktop Cube - A Desktop Cube for GNOME Shell (Extensions / Visual Changes)
- stars - Schneegans/Desktop-Cube
README
A Desktop Cube for GNOME Shell
> [!IMPORTANT]
> The code in the `main` branch is for GNOME Shell 45+. For older GNOME versions, please use the `gnome-40-41` or `gnome-42-44` branches respectively.
When I started using Linux more than a decade ago, it was because of the 3D desktop cube of Compiz.
Even if this was a pretty useless feature, I am still missing it today.
Therefore, I decided to create a similar effect for GNOME Shell.
If you like it, you may also be interested in other nostalgic extensions, such as [Compiz windows effects](https://extensions.gnome.org/extension/3210/compiz-windows-effect/), or [Burn-My-Windows](https://extensions.gnome.org/extension/4679/burn-my-windows/)!
For a list of things changed in previous releases, you can have a look at the [changelog](docs/changelog.md)!
## 🎉 Features
| 
**3D Overview:** The extension arranges the workspaces in the overview in a cube-like fashion. | 
**3D Workspaces:** Also, when switching workspaces with touch gestures or keyboard shortcuts, the cube is shown. |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| 
**Click and drag the desktop to rotate the cube:** You can click and drag anywhere on the desktop to start rotating the cube! | 
**Click and drag the panel to rotate the cube:** You can also trigger the cube by dragging on the panel. This is useful with maximized windows. |
| 
**Click and drag the overview to rotate the cube:** You can also click and drag the overview's background to rotate the cube. | 
**Explode the cube on vertical rotations:** If you rotate the cube up or down, the 3D effect will become more intense. |
| 
**Smooth transitions between Desktop, Overview, and App Drawer:** If you enter the app-drawer mode, the cube will be unfolded. | 
**Dynamic workspaces:** The extension supports any number of workspaces. So it's actually not a cube most of the time... |
| 
**Background panoramas:** You can select an image which will be used as 360° skybox. | 
**Drag windows to other workspaces:** You can directly drag windows to adjacent workspaces. This also works in the overview. |
## 🪲 Limitations
Issues are tracked [here on GitHub](https://github.com/Schneegans/Desktop-Cube/issues). There are currently two main known limitations:
- **No wrap-around:** In GNOME Shell, it is not possible to change from the last to the first workspace. The Desktop-Cube extension does not change this.
- **Bad multi-monitor support on X11:** On X11, GNOME Shell uses the same projection and view matrices for all monitors. The extension can modify these matrices so that the projection center of the virtual camera is in front of the current monitor. However, the cube looks somewhat sheared on setups with multiple monitors if the cube is shown on all monitors.
## 💞 Show that you love the Desktop Cube!
[](https://ko-fi.com/schneegans)
[](https://github.com/sponsors/Schneegans)
[](https://www.paypal.com/donate/?hosted_button_id=3F7UFL8KLVPXE)
[](https://schneegans.cb.id)
While coding new features or translating the Desktop Cube is the most awesome way to contribute, providing financial support will encourage me to invest my spare time for developing free and open-source software.
**These awesome people have already donated to the development of my open-source projects:**
[](https://schneegans.github.io/sponsors/)
Do you want to show that you love it too? If you donate via [Ko-fi](https://ko-fi.com/schneegans), [GitHub](https://github.com/sponsors/Schneegans), or [PayPal](https://www.paypal.com/donate/?hosted_button_id=3F7UFL8KLVPXE), you will show up in this list as well!
## ⬇️ Installation
You can either install the Desktop Cube extension from extensions.gnome.org (a), download a stable release
from GitHub (b) or clone the latest version directly with `git` (c).
### a) Installing from extensions.gnome.org
This is the easiest way to install the Desktop Cube extension. Just head over to
[extensions.gnome.org](https://extensions.gnome.org/extension/4648/desktop-cube) and flip the switch!
If you want to use a more up-to-date version, you can try one of the methods listed below.
### b) Downloading a Stable Release
Execute this command to download the latest stable release:
```bash
wget https://github.com/Schneegans/Desktop-Cube/releases/latest/download/[email protected]
```
Install it by executing the following command. If you have the Desktop Cube extension already installed and want to upgrade to
the latest version, append the `--force` flag in order to overwrite existing installs of the Desktop Cube extension.
```bash
gnome-extensions install [email protected]
```
Then restart GNOME Shell with Alt + F2, r + Enter.
Or logout / login if you are on Wayland.
Then you can enable the extension with the _Gnome Tweak Tool_, the _Extensions_ application or with this command:
```bash
gnome-extensions enable [email protected]
```
### c) Cloning the Latest Version with `git`
You should **not** clone the Desktop Cube extension directly to the `~/.local/share/gnome-shell/extensions` directory as this may get overridden occasionally!
Execute the clone command below where you want to have the source code of the extension.
```bash
git clone https://github.com/Schneegans/Desktop-Cube.git
cd Desktop-Cube
```
If your GNOME Shell version is <= 45, you will have to checkout the `gnome-42-44` branch:
```bash
git checkout gnome-42-44
```
Now you will have to install the extension.
The `make` command below compiles the locales, schemas and resources, creates a zip file of the extension and finally installs it with the `gnome-extensions` tool.
```bash
make install
```
Then restart GNOME Shell with Alt + F2, r + Enter.
Or logout / login if you are on Wayland.
Then you can enable the extension with the _Gnome Tweak Tool_, the _Extensions_ application or with this command:
```bash
gnome-extensions enable [email protected]
```
## :octocat: I want to contribute!
That's great!
Here are some basic rules to get you started:
Commits should start with a Capital letter and should be written in present tense (e.g. **:tada: Add cool new feature** instead of **:tada: Added cool new feature**).
You should also start your commit message with **one** applicable emoji.
This does not only look great but also makes you rethink what to add to a commit. Make many but small commits!
| Emoji | Description |
| --------------------------------------------------------- | ------------------------------------------------------------------------- |
| :tada: `:tada:` | When you added a cool new feature. |
| :wrench: `:wrench:` | When you added a piece of code. |
| :recycle: `:recycle:` | When you refactored a part of the code. |
| :sparkles: `:sparkles:` | When you applied clang-format. |
| :globe_with_meridians: `:globe_with_meridians:` | When you worked on translations. |
| :art: `:art:` | When you improved / added assets like themes. |
| :lipstick: `:lipstick:` | When you worked on the UI of the preferences dialog. |
| :rocket: `:rocket:` | When you improved performance. |
| :memo: `:memo:` | When you wrote documentation. |
| :beetle: `:beetle:` | When you fixed a bug. |
| :revolving_hearts: `:revolving_hearts:` | When a new sponsor is added or credits are updated. |
| :heavy_check_mark: `:heavy_check_mark:` | When you worked on checks or adjusted the code to be compliant with them. |
| :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merged a branch. |
| :fire: `:fire:` | When you removed something. |
| :truck: `:truck:` | When you moved / renamed something. |