Skip to content

DOD-101/dod-shell

Repository files navigation

dod-shell

My personal shell designed to be integrated with my NixOs config

❗ Note ❗

This is designed primarily for my personal use. Because of this don't expect this to be super-duper configurable or act like a sort of widget framework. If you are looking for something like that I recommend looking at something like ags or eww.

Nonetheless if you are looking to write your own shell / widgets from scratch using rust this repo will be a valuable resource on how to do just that.

🏗️ Todo 🏗️

  • Write the actual components
  • Write tests
  • Document all of the code

✨ Components ✨

Preview of all components

Details Image credit: [Apollo 17, NASA, Image Reprocessing: Andy Saunders](https://apod.nasa.gov/apod/ap251227.html) Styling: Catppuccin (see my [NixOS config](https://github.com/dod-101/NixOs-dots) for more details) ]

Launcher

Let's you launch apps, do simple calculations, search the web & view your clipboard history

Launcher preview

Bar

Displays useful system information

Bar preview

Osk (On-screen-keyboard)

Allows you type using your touchscreen

Osk Preview

Overlay (Soon™)

Overlay to control different parts of the shell and other parts of your system

CLI

dod-shell-cli help

🖌️ Styling & Config 🖌️

All files are located in $HOME/.config/dod-shell

  • Style: style.scss (using gtk-css & scss as a pre-processor)

  • Main Config: config.toml

  • Osk layouts: layouts.json

Tip

Run dod-shell-cli generate-config to get a good place to start from including a json schema for layouts.json

License

This project is licensed under either of

at your option.

About

My custom ui shell written from scratch in rust.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE_APACHE.txt
MIT
LICENSE_MIT.txt

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages