https://github.com/matzkoh/niconizer
A desktop application that displays plain text, images, or any other HTML content on the screen, like nicovideo or bilibili.
https://github.com/matzkoh/niconizer
bilibili desktop-application electron niconizer nicovideo
Last synced: 10 months ago
JSON representation
A desktop application that displays plain text, images, or any other HTML content on the screen, like nicovideo or bilibili.
- Host: GitHub
- URL: https://github.com/matzkoh/niconizer
- Owner: matzkoh
- License: mit
- Created: 2019-01-09T13:30:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-07T21:12:11.000Z (11 months ago)
- Last Synced: 2025-08-08T07:42:36.093Z (11 months ago)
- Topics: bilibili, desktop-application, electron, niconizer, nicovideo
- Language: TypeScript
- Homepage:
- Size: 23.1 MB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CircleCI][circleci-badge]][circleci]
[![Renovate][renovate-badge]][renovate]
[![npm][npm-badge]][npm]
[circleci]: https://circleci.com/gh/matzkoh/niconizer
[circleci-badge]: https://circleci.com/gh/matzkoh/niconizer.svg?style=shield
[renovate]: https://renovatebot.com/
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen
[npm]: https://www.npmjs.com/package/niconizer
[npm-badge]: https://img.shields.io/npm/v/niconizer.svg
# 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
```bash
$ npm i -g niconizer
$ niconizer
```
Then the WebSocket server starts up on your computer and listens for connections.
Available clients are in the [section](#clients) 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
- Slack
- [niconizer-slack](https://github.com/matzkoh/niconizer-slack)
- Twitter
- [niconizer-tweetdeck](https://github.com/matzkoh/userscripts/tree/master/packages/niconizer-tweetdeck)
## Develop client
**Currently, no authentication is implemented.**
---
### Node.js
```js
// WebSocket implementation for nodejs
const WebSocket = require("ws");
// niconizer server
const ws = new WebSocket("ws://localhost:25252/");
// any html content
ws.send("Hello, world!");
```
### Browser (assuming use from userscripts such as Greasemonkey)
```js
const ws = new WebSocket("ws://localhost:25252/");
ws.send("Hello, world!");
```
### Shell Script
```sh
wscat -c ws://localhost:25252 -x "$(jq -r '.name' package.json)"
```
## Contributing
Lint, Format, Build
```bash
$ npm run build
```
Build, Run
```bash
$ npm start
```
Package
```bash
$ npm run package
```