Giter VIP home page Giter VIP logo

gost's Introduction

gost

A JSON feeder for i3bar/swaybar

Installation

TBD...

Configuration

The application is configured via a file in ${XDG_CONFIG_HOME}/gost/config.yml (usually $HOME/.config/gost/config.yml).

config.yml:

version: "1"

theme:
  hue: 0.7
  saturation: 0.7

separator_width: 16

blocks:
  - name: foo_block
    config_option_1: bar_value
    config_option_2:
      - baz_value

sway/config (or i3/config):

bar {
  status_command gost
  # ...
}

You can grab the example config from doc/example-config.yml:

$ curl -sL -o "${XDG_CONFIG_HOME:-$HOME/.config}/gost/config.yml" \
    https://raw.githubusercontent.com/kraftwerk28/gost/master/doc/example-config.yml

Blocklets

Display battery charge level. Requires UPower to work over DBus upower_device can be obtained via DBus using the following command:

$ busctl --json=pretty --system call org.freedesktop.UPower \
  /org/freedesktop/UPower org.freedesktop.UPower \
  EnumerateDevices \
  | jq -r '.data[0] | map(match("[^/]+$").string)[]'`

If empty, the program will try to detect battery device.

Option Type Description
format ConfigFormat
upower_device string Device name. See above.
urgent_level int

Displays connected bluetooth devices

Option Type Description
mac string Mac address of the device
format ConfigFormat
device_format ConfigFormat Device format
Option Type Description
format ConfigFormat
Option Type Description
object_path string
initial_text string
Option Type Description
script string
Option Type Description
player_format ConfigFormat
separator string
Option Type Description
format ConfigFormat
ap_format ConfigFormat
primary_only bool
Option Type Description
node string
format ConfigFormat
icons PulseIconsConfig

Displays output for a shell script It has three modes:

  • run script every N seconds, wait for it to exit
  • run script once, read lines from it's stdout and update the blocklet per each line
  • run script in a loop as soon as it exits
Option Type Description
command string Shell command to run
on_click string Shell command to run when a blocklet is clicked
interval ConfigInterval
restart_on_exit bool
json bool Treat command's output as json instead of plain text

Displays current keyboard layout. Uses sway's IPC API for retrieving the info (i.e. won't work with i3wm)

Option Type Description
format ConfigFormat
input string

No config fields.

Option Type Description
format ConfigFormat
layout string
interval ConfigInterval

This project is inspired by i3status-rust and i3blocks

gost's People

Contributors

kraftwerk28 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.