https://github.com/disruptek/swayipc

swayipc (i3ipc) for Nim
https://github.com/disruptek/swayipc

client i3 i3ipc ipc library manager nim sway swaymsg swaywm wayland window x11

Last synced: 12 months ago
JSON representation

swayipc (i3ipc) for Nim

• Host: GitHub
• URL: https://github.com/disruptek/swayipc
• Owner: disruptek
• License: mit
• Created: 2019-07-26T17:29:31.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-30T17:11:30.000Z (over 5 years ago)
• Last Synced: 2025-04-09T16:18:30.942Z (about 1 year ago)
• Topics: client, i3, i3ipc, ipc, library, manager, nim, sway, swaymsg, swaywm, wayland, window, x11
• Language: Nim
• Homepage:
• Size: 98.6 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# swayipc

[![Test Matrix](https://github.com/disruptek/swayipc/workflows/CI/badge.svg)](https://github.com/disruptek/swayipc/actions?query=workflow%3ACI)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/disruptek/swayipc?style=flat)](https://github.com/disruptek/swayipc/releases/latest)

![Minimum supported Nim version](https://img.shields.io/badge/nim-1.0.8%2B-informational?style=flat&logo=nim)

[![License](https://img.shields.io/github/license/disruptek/swayipc?style=flat)](#license)

[![buy me a coffee](https://img.shields.io/badge/donate-buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/disruptek)

It's like swaymsg (in sway) or i3ipc (in i3) but in native Nim.

You might find these docs for i3ipc useful: https://i3wm.org/docs/ipc.html

See also [the useful examples below](#examples).

## Documentation

See [the documentation for the swayipc module](https://disruptek.github.io/swayipc/swayipc.html) as generated directly from the source.

## Usage

```nim

import asyncdispatch

from strutils import spaces

import swayipc

proc dump(tree: TreeReply; indent=0) =

  echo indent.spaces, tree.id, " ", tree.`type`

  for n in tree.nodes:

    n.dump(indent + 2)

  for n in tree.floating_nodes:

    n.dump(indent + 2)

var

  # connect to a compositor at an optional socket path

  compositor = waitFor newCompositor("../some/path")

  # synchronous tree retrieval

  reply = compositor.invoke(GetTree)

dump(reply.tree)

#1 root

#  2147483647 output

#    2147483646 workspace

#  15 output

#    26 workspace

#      28 con

#      39 con

#      49 floating_con

#    37 workspace

#      36 con

#    38 workspace

#      34 con

#    50 workspace

#      6 floating_con

#    7 workspace

#      5 con

# you can pass extra arguments for a command (as strings)

reply = waitFor GetBarConfig.invoke("status")

assert reply.bar.config.mode == "hide"

# you can invoke `send` to instantiate the compositor

block:

  var

    compositor = waitFor RunCommand.send("opacity 0.5")

    # receive the reply

    receipt = waitFor compositor.recv()

    # maybe you want to twiddle your own json?

    js = receipt.data

    # or, nah, that's silly...

    reply = receipt.reply

  # multiple command results are returned as a sequence

  assert reply.ran[0].success

# an example subscription iterator:

iterator focusChanges(): WindowEvent =

  let compositor = waitFor Subscribe.send("[\"window\"]")

  while true:

    let receipt = waitFor compositor.recv()

    if receipt.kind != EventReceipt:

      continue

    if receipt.event.kind != Window:

      continue

    if receipt.event.change != "focus":

      continue

    yield receipt.event.window

for window in focusChanges():

  echo window.name, " now has focus"

```

## Examples

- [reposition and resize floating windows matching any of a series of regexps](https://github.com/disruptek/xs/blob/master/geometry.nim)

- [automagically adjust the opacity of windows according to whether they are focussed](https://github.com/disruptek/xs/blob/master/autoopacity.nim)

## License

MIT