2023-12-19 18:39:11 +03:00
|
|
|
**WARNING**: This project is very much a work in progress. I have provided a rough roadmap in the timeline section.
|
|
|
|
|
Use at your own risk.
|
|
|
|
|
|
2023-12-21 19:34:04 +03:00
|
|
|
# miracle
|
|
|
|
|
**miracle** is a _Mir_-based, Wayland desktop environment inspired by modern IDEs. The window manager intends
|
|
|
|
|
to provide a typical tiling window management experience (akin to i3 or sway). The shell focuses on usability for
|
|
|
|
|
programmers by being extendable and providing a JetBrains-inspried interface. While window managers like i3 and sway
|
|
|
|
|
are simple but barebones, miracle will provide a heavier out-of-the-box-solution that is geared towards making
|
|
|
|
|
the life of the average programmer happy and productive. If you like the lightweight nature of other IDEs, then this
|
|
|
|
|
one might not be for you. But if you want your desktop environment to provide a host of useful facilities at your
|
|
|
|
|
fingertips, then look no futher!
|
|
|
|
|
|
|
|
|
|
While **miracle** intends to be a full desktop environment, the tiling window management facilities will always
|
|
|
|
|
be provided as a standalone option so that you might use your own shell if you like.
|
|
|
|
|
|
2023-12-19 18:39:11 +03:00
|
|
|
# Building
|
2023-02-25 21:09:26 +03:00
|
|
|
```
|
2023-12-07 17:52:38 +03:00
|
|
|
git clone https://github.com/mattkae/miracle.git
|
|
|
|
|
cd miracle
|
|
|
|
|
|
2023-02-18 20:06:27 +03:00
|
|
|
mkdir build
|
|
|
|
|
cd build
|
|
|
|
|
cmake ..
|
2023-12-07 17:52:38 +03:00
|
|
|
./bin/compositor
|
2023-02-18 20:06:27 +03:00
|
|
|
```
|
|
|
|
|
|
2023-12-19 18:39:11 +03:00
|
|
|
# Timeline
|
|
|
|
|
## Tiling Window Manager (Due: January 1st)
|
|
|
|
|
Version: 0.1
|
|
|
|
|
|
|
|
|
|
Features:
|
2023-12-07 17:52:38 +03:00
|
|
|
- [x] Layout new window
|
|
|
|
|
- [x] Delete window
|
2023-12-19 18:39:11 +03:00
|
|
|
- [x] Resizing windows
|
|
|
|
|
- [x] Changing selected window with keyboard
|
|
|
|
|
- [x] Moving window with keyboard
|
2023-12-07 17:52:38 +03:00
|
|
|
- [ ] Gaps in windows
|
|
|
|
|
- [ ] Account for minimum sizes on windows (e.g. gedit)
|
2023-12-28 21:31:57 +03:00
|
|
|
- [x] Disabling many of the Floating Window Manager features
|
2023-12-19 18:39:11 +03:00
|
|
|
- [ ] Handle exclusion zones
|
|
|
|
|
- [ ] Handle output creation, updating, and deletion
|
2023-02-25 21:09:26 +03:00
|
|
|
|
2023-12-19 18:39:11 +03:00
|
|
|
## Tiling Advanced + Initial Shell (Due: February 1st)
|
|
|
|
|
Version: 0.2
|
|
|
|
|
|
|
|
|
|
Features:
|
2023-12-07 17:52:38 +03:00
|
|
|
- [ ] Workspaces
|
|
|
|
|
- [ ] Moving windows between workspaces
|
2023-12-19 18:39:11 +03:00
|
|
|
- [ ] Launcher (Rust + GTK most likely)
|
|
|
|
|
- [ ] Favorite applications
|
|
|
|
|
- [ ] Opened applications
|
|
|
|
|
- [ ] Favorite folders
|
|
|
|
|
- [ ] Pinned scripts
|
|
|
|
|
- [ ] Top Panel
|
|
|
|
|
- [ ] Clock
|
|
|
|
|
- [ ] Battery indicator
|
|
|
|
|
- [ ] Wifi Indicator
|
|
|
|
|
- [ ] Lock Screen
|
2023-12-21 19:34:04 +03:00
|
|
|
- [ ] Weather
|
2023-12-19 18:39:11 +03:00
|
|
|
|
2023-12-21 19:34:04 +03:00
|
|
|
## Tiling More Advanced + Futher UI
|
2023-12-19 18:39:11 +03:00
|
|
|
Version: 0.3
|
2023-10-27 23:26:34 +03:00
|
|
|
|
2023-12-19 18:39:11 +03:00
|
|
|
Features:
|
|
|
|
|
- [ ] UI Cleanup
|
2023-12-21 19:34:04 +03:00
|
|
|
- [ ] UI Plugin Interface
|
2023-12-07 17:52:38 +03:00
|
|
|
- [ ] Configuration file
|
2023-12-19 18:39:11 +03:00
|
|
|
- [ ] Settings application
|
2023-12-07 17:52:38 +03:00
|
|
|
- [ ] Visual Sugar
|
|
|
|
|
- [ ] A workspace visualizer in the top panel (in-memory app)
|
|
|
|
|
- [ ] A tile visualizer in the top panel (in-memory app)
|
