Skip to content

A desktop application that displays plain text, images, or any other HTML content on the screen, like nicovideo or bilibili.

License

Notifications You must be signed in to change notification settings

matzkoh/niconizer

Repository files navigation

CircleCI Renovate npm

niconizer

What is this

niconizer is a simple desktop application that has two functionalities below.

  • Overlay short HTML content directly on the screen.
    • The content flows from right to left on the screen and disappears.
  • Local WebSocket server to receive the content.

It can be used in combination with clients that send contents.

Getting started

Installation

$ npm i -g niconizer
$ niconizer

Then the WebSocket server starts up on your computer and listens for connections.

Available clients are in the section bellow.

Tray Icon Menu

  • Start
    • Open a transparent window that shows the content.
  • Stop
    • Close the window and pause displaying the content.
  • Quit
    • Quit niconizer.

Clients

Develop client

Currently, no authentication is implemented.


Node.js

// WebSocket implementation for nodejs
const WebSocket = require("ws");

// niconizer server
const ws = new WebSocket("ws://localhost:25252/");

// any html content
ws.send("<b>Hello, world!</b>");

Browser (assuming use from userscripts such as Greasemonkey)

const ws = new WebSocket("ws://localhost:25252/");

ws.send("<b>Hello, world!</b>");

Shell Script

wscat -c ws://localhost:25252 -x "$(jq -r '.name' package.json)"

Contributing

Lint, Format, Build

$ npm run build

Build, Run

$ npm start

Package

$ npm run package