Skip to content

Latest commit

 

History

History
145 lines (104 loc) · 6.07 KB

readme.md

File metadata and controls

145 lines (104 loc) · 6.07 KB
Raw

Hudkit

This is a fork of hudkit by anko intended for use with ngld's OverlayPlugin for ACT. The original readme is below until this can be updated properly.

Usage

  1. Clone repo and compile
cd /tmp
git clone https://github.com/valarnin/hudkit.git
cd hudkit/webkit
make
  1. Let hudkit create a template json file for you
./hudkit example.json
  1. Edit example.json with your preferred text editor. Here's the default template with comments:
{
    "title":"example overlay", //Title of the window, to make it easier to identify
    "url":"file:///path/to/file.html?OVERLAY_WS=ws://127.0.0.1:10501/ws", //URL to the overlay
    "x":100, // X position to display overlay at
    "y":100, // Y position to display overlay at
    "width":200, // Width of overlay
    "height":200, // Height of overlay
    "hotkey":"<Ctrl>L" // Hotkey to lock/unlock the overlay
}
  1. Run the overlay
./hudkit example.json
  1. Unlock the overlay with the hotkey from the config file (Ctrl+L by default), reposition/resize, and re-lock the overlay with the same hotkey. This will update example.json with the new x/y/width/height values.

Known issues

  • Size on launch might still be messed up in some edge cases. I think this is good but needs more testing.
  • When the overlay is unlocked, it tends to lose its "always-on-top" flag. If that happens, click the "window is ready" notification to get back focus and move it to the top. When the overlay is re-locked, the flag seems to be fine so not sure exactly what's going on with it.
  • This is written in C. I'd really like to move it to C++ with some proper class support etc.

Original Readme

Hudkit

A web-based Head-Up Display for your desktop, using the WebKit browser engine.

Hudkit lets you use web technologies (HTML, CSS, JavaScript, WebSockets, etc.) to draw and animate anything on a click-through transparent fullscreen layer over your desktop. You know, like military planes have! Except on your monitor(s)! As a chromeless web browser!

Fastest way to check if this works

cd /tmp
git clone https://github.com/anko/hudkit.git
cd hudkit
make
cd example
./run.sh

Install the dependencies if make complains.

General usage

Ensure your windowing environment has compositing enabled! If you're running a plain window manager, a standalone compositor like compton running should be enough.

  1. Start a web server, with Python or Node.js or whatever you like. Serve up an HTML page with a transparent background. Let's say the server is at localhost:8000.
  2. Run hudkit http://localhost:8000
  3. Enjoy the eye candy! 🌈

See example/ for a quick test script and starting point.

JavaScript API

The JavaScript on the page context has an object Hudkit preloaded. Hudkit.monitors is an array with each of your monitors represented by a {x,y,width,height}-object. You can use this to position statusbars or notification messages.

DOM APIs like SVG work as you'd expect.

WebSockets work normally too. You can use them to send live data from your system to the overlay. If you're writing your server in Node.js, maybe use dnode to remote-procedure-call the Node.js API from page context, or just SockJS if just a stream is enough, or both.

Ideas for what to send it that might be fun:

  • keystrokes captured by xkbcat,
  • Twitch chat Kappa,
  • name of the currently playing music track,
  • recently received chat messages,
  • pstree (port pscircle to JS with a D3.js tree layout?),
  • sensors for hardware temperatures and fan data,
  • more JavaScript code to eval.

WebGL doesn't work. You're still welcome to try.

Install

make

Dependencies

You'll need GTK 3, and a corresponding webkit2gtk.

On Arch, the packages are called gtk3 and webkit2gtk.

On Void, they are gtk+3-devel and webkit2gtk-devel.

If you build on another distro, tell me how it went! If it failed, raise an issue. If it worked, submit a PR to this readme with the packages you needed, or just email me if you don't have a Github.

Limitations

  • Requires a restart if rearranging monitors. Hudkit can handle multi-monitor setups: it detects their arrangement on startup, not dynamically.
  • It's only WebKit. Consequently, you probably can't use WebGL, WebAudio, WebVR, or any other brand new web API.

Alternatives

  • Electron. I've heard it's possible: Start it with --enable-transparent-visuals --disable-gpu. Call win.setIgnoreMouseEvents, set all the possible "please dear WM, do not touch this window"-flags, call the screen API for monitor arrangements and position your window accordingly. Sacrifice 55 paperclips to Eris of Discordia.

    It didn't work for me. I just couldn't get a transparent or click-through window out of Electron, but maybe you can. Let me know if you do.

    You'd get a nicer API (:sparkles:Page-context Node.js integration! Chromium web engine!:sparkles:), though continuing support for your use-case will probably be even more fragile than what Hudkit relies on.

License

ISC.