Skip to content
kb100 edited this page Oct 2, 2015 · 9 revisions

What is a blocklet?

A blocklet is the configuration of a single block, part of the status line. This repository is dedicated to collecting the vast work of the i3blocks community in creating these blocklets.

Can I share a blocklet that I've written?

Absolutely! See the guidelines on blocklet contributions.

What if there is already a similar blocklet to mine in the repo?

Still okay! There are many different ways to write the same blocklet. Some people don't want certain dependencies. Some people like one look and feel over another. Some people want bells and whistles. Some people want minimalism. If you think your blocklet is different enough, submit it.

Can I request a blocklet that doesn't exist yet?

Yes, create an issue on the issues page with your request. Please include [Request] in the title of the issue. Contributors will discuss the request and if you are lucky the request may be implemented.

What is the difference between blocklets here and those in i3blocks?

The blocklets in the main i3blocks repository are considered core blocklets that most users would want enabled by default, and that depend only on GNU standard utilities like bash and perl. The blocklets in this repository are allowed to have reasonable dependencies and are not required to be desirable for everyone. If you want to contribute a blocklet, you should most likely contributed it here, not to i3blocks.

A blocklet doesn't work or I've found a bug, how can I best report it?

Create an issue on the issues page. Make sure to include as much information as possible. If a blocklet is showing no output or wrong output, also make sure to try running it from the command line and to post any interesting results.


Take a look at i3blocks' FAQ for more often confusing details.

Clone this wiki locally