https://github.com/mikkurogue/viperbar

https://github.com/mikkurogue/viperbar

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mikkurogue/viperbar
• Owner: mikkurogue
• Created: 2024-07-22T18:21:49.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-07-30T18:00:36.000Z (10 months ago)
• Last Synced: 2025-03-19T21:49:43.789Z (2 months ago)
• Language: Rust
• Size: 52.7 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://opensource.org/)

# Viperbar

A blazingly (cause its the rust meme) utility bar for Wayland (and maybe not Wayland?) compositors.

## Docs:

This docs page will move one day to its own wiki thing but now it can't do much.

## Config

We support creating a custom config.

Must create a config in `~/.config/viperbar/viperbar.json`. For best results, I recommend installing and using a nerdfont on your system to display icons. However I do have plans to try and get other icon types (svg's) working.

Each of these keys are the built in modules. Eventually we will allow positional placements.

Example config:

```json

{

  "weather": {

    "api_key": "",

    "country_code": "UK", // This is the ISO 3166-1 alpha-2 standard, 2 letter country codes

    "city": "London"

  },

  "clock": {

    "format": "%d/%m%Y %H/%M/%S"

  },

  "quickLaunch": [

    {

      "icon": " ",

      "tooltip": "Discord",

      "exec": "discord"

    },

    {

      "icon": "",

      "tooltip": "Terminal",

      "exec": "kitty"

    },

    {

      "icon": "",

      "tooltip": "Spotify",

      "exec": "spotify"

    },

    {

      "icon": "󰈹",

      "tooltip": "Firefox",

      "exec": "firefox"

    },

    {

      "icon": "󰨞",

      "tooltip": "VSCode",

      "exec": "code"

    },

    {

      "icon": "",

      "tooltip": "Steam",

      "exec": "steam"

    }

  ]

}

```

## Quick launch

Launches an app from Viperbar, can be customized through the config.