Skip to content

protocol.md

Latest commit

 

History

History
65 lines (52 loc) · 1.15 KB

protocol.md

File metadata and controls

65 lines (52 loc) · 1.15 KB
Raw

Protocol Reference

The current wire protocol version is 1.

Plugin Kinds

  • logo_animation
  • info_provider

Logo Animation Request

{
  "version": 1,
  "kind": "logo_animation",
  "lines": ["line 1", "line 2"],
  "frames": [["frame 1"], ["frame 2"]],
  "args": {
    "fps": 12,
    "duration_ms": 1200,
    "loop": true,
    "style": "wave"
  }
}

Logo Animation Response

{
  "frames": [
    {
      "delay_ms": 80,
      "lines": ["rendered line 1", "rendered line 2"]
    }
  ]
}

Info Provider Request

{
  "version": 1,
  "kind": "info_provider",
  "args": {
    "username": "example",
    "max_lines": 5
  }
}

Info Provider Response

{
  "lines": [
    "line one",
    "line two"
  ]
}

Compatibility

Protocol changes should be introduced in this repository first and then adopted by the core and official plugin repositories together.