Giter VIP home page Giter VIP logo

wired-notify's Introduction









Wired

Wired is light and fully customizable notification daemon that provides you with powerful and extensible layout tools.

Features

  • Layout - position every element how you want it, see wiki for more info.
  • Programmable and Interactable Layout Elements - code your own or use layout elements from wired and contributors (accepting pull requests!).
    • Text blocks which scroll.
    • Backgrounds which reflect state (paused, active, extended, etc).
    • Layout elements can fire events on click (open url, etc).
    • More soon.
  • First Class Mouse Actions - close, pause, and open urls within a notification with a click.
    • Open an issue if you have ideas of more actions.
  • Every notification is a different window - pretty sick of stuff only being able to show one notification at a time honestly.

Showcase

Check out what other people have made with Wired!

Config

See the Config wiki page for configuration settings.

Wiki

See the wiki for everything else you need to know about using Wired.

Making your own elements

Making your own layout elements is designed to be as easy as possible. Anybody who knows basic Rust should be able to make a layout element. See the wiki for a detailed tutorial on making and adding a layout element to Wired.

Building

Dependencies

rust, dbus, cairo, pango, glib2, x11, xss (for idle support)

Build and Run

$ git clone https://github.com/Toqozz/wired-notify.git
$ cd wired-notify
$ cargo build --release
$ ./target/release/wired

Installing

AUR

Wired is available on the AUR!

$ yay -S wired

There's also a -git version which tracks master. Beware! No guarantees are made about stability on the master branch. However, I do appreciate any help finding bugs before they make it to a release:

$ yay -S wired-git

Nix (Flakes)

Flake support was added to Nix in version 2.4. As of Nix 2.8, you must enable the nix-command and flakes experimental features.

Wired can be run directly from the repository, using:

nix run 'github:Toqozz/wired-notify'

To install Wired to your user profile:

# note: the systemd service will not be available if installed with this method
nix profile install 'github:Toqozz/wired-notify'

To use it in another flake:

{
  inputs = {
    wired.url = "github:Toqozz/wired-notify";
  };
}

Install for all users in NixOS

{
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
    wired.url = "github:Toqozz/wired-notify";
  };
  outputs = { self, nixpkgs, wired }: let
    std = nixpkgs.lib;
    system = "x86_64-linux";
  in {
    nixosConfigurations.alice = std.nixosSystem {
      inherit system;
      modules = [
        ./configuration.nix
        {
          environment.systemPackages = [ wired.packages.${system}.wired ];
        }
      ];
    };
  };
}

Home-Manager

Standalone

This flake also provides a module for home-manager if you installed it standalone. To use it in your configuration:

{
  # ...
  outputs = { self, nixpkgs, home-manager, wired, ... }: {
    homeConfigurations.alice = let
      system = "x86_64-linux";
    in home-manager.lib.homeManagerConfiguration {
      pkgs = import nixpkgs {
        inherit system;
        overlays = [ wired.overlays.default ];
      };

      modules = [
        wired.homeManagerModules.default
        ({ ... }: {
          services.wired = {
            enable = true;
            config = ./wired.ron;
          };
        })
      ];
    };
  };
}
Home-Manager - NixOS-Module

If you're using home-manager as a NixOS-Module, then you simply need to add the provided overlay and home-manager-module to nixpkgs.overlays and home-manager.sharedModules:

nixpkgs.overlays = [
  inputs.wired-notify.overlays.default
];

home-manager.sharedModules = [
    inputs.wired-notify.homeManagerModules.default
];

then you'll have services.wired in your home-manager config.

NetBSD

Wired is available from the official repositories,

$ pkgin install wired-notify

or, if you prefer to build from source

$ cd /usr/pkgsrc/x11/wired-notify
$ make install

Fedora, CentOs and other RHEL-based distributions

Make sure you have DNF installed, and run the script with sudo permissions, otherwise the necessary dependencies cannot be installed.

$ cd wired-notify
$ chmod +x installer.sh
$ sudo ./installer.sh

Running

The recommended way to start Wired is just to put the following in your autostart script:

/path/to/wired &

There is also a wired.service file in the root of the repository if you want to use systemd. Just copy it to /usr/local/lib/systemd/user/wired.service (or your distro equivalent) and run:

$ systemctl enable --now --user wired.service

wired-notify's People

Contributors

0323pin avatar andresd172 avatar bcspragu avatar beyondmagic avatar blarse avatar christian-rades avatar dependabot[bot] avatar dithpri avatar epsylon42 avatar github-actions[bot] avatar jokeyrhyme avatar jx11r avatar lordmzte avatar lukasdoesdev avatar matanhamilis avatar oddlama avatar pleshevskiy avatar sevenautumns avatar signalwalker avatar tdpeuter avatar toqozz avatar tornaxo7 avatar vuimuich avatar xero-lib 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.