GWSTUFF

https://docs.rs/smithay-client-toolkit/0.15.4/smithay_client_toolkit/index.html

RoadMap

MVP:

• Render on focused screen
• layer alignment
• text from line arguments
• Line text alignment
• General style
  • Config file parser
    • bg_color
    • bg_trasparency
    • padding
    • margins
    • font_name
    • font_size
    • font_color
    • intra_line_space
• Font Proper Scaling
• Timer - SORT OF - not really beautiful =======
• Duration

Future:

• layer render only on specified screen

Welcome to gwstuff!

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Gwstuff is a deamon-less lightweight notification program for Wayland compositors that can show a box with customizable text in it.

Built With

• Smithay client toolkit

Prerequisites

In order to use gwstuff you should be running a Wayland compositor (like Sway, GNOME, KDE, ...).

You will also need fontconfig

To compile gwstuff from source you should have rustc and cargo installed

Installation

1. Clone the repo

   git clone https://github.com/gabriele-0201/gwstuff.git

2. Open it in a terminal
3. Run

cargo build --realease

Now the executable program should be at ./target/release/gwstuff and you can run a test by executing

./target/release/gwstuff "hello world"

(back to top)

Usage

You can run the program with the default config just by using

gwstuff "your text here" "this text goes to a new line" "this text goes to the 3rd line"

Or you can specify a custom configuration following this steps:

• Create your own config file, according to the template
• Note: the available fonts on your system can be listed with fc-list
• Run gwstuff specifying the configuration name (not filename):

  gwstuff --<myConfig> "your text here" "this text goes to the 2nd line" "this text goes to the 3rd line"

Here are some example usecases:

• Getting important stats of your system
• Having a customizable slider for display backlight and/or volume
• Integrating fast notification in your own project
• Showing reminders or timers

TODO/Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

If you have a suggestion that would make the project better, fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star if you liked it!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.