# niconizer

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

Latest version **2.0.155** (published 2025-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install niconizer
pnpm add niconizer
yarn add niconizer
bun add niconizer
```

Provides the command `niconizer`.

## Health

**Score 40/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.155 |
| Published | 2025-08-07 |
| First published | 2019-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 (+40 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | matzkoh |
| Keywords | bilibili, comment, desktop, electron, gadget, nicovideo |

## Links

- npm: https://www.npmjs.com/package/niconizer
- Repository: https://github.com/matzkoh/niconizer
- Homepage: https://github.com/matzkoh/niconizer#readme
- Issues: https://github.com/matzkoh/niconizer/issues
- npm.io page: https://npm.io/package/niconizer

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) 8.18.3
- [pkg-dir](https://npm.io/package/pkg-dir.md) 9.0.0
- [electron](https://npm.io/package/electron.md) 37.2.6
- [file-uri-to-path](https://npm.io/package/file-uri-to-path.md) 2.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.155 (latest) — 2025-08-07
- 2.0.154 — 2025-08-02
- 2.0.153 — 2025-07-25
- 2.0.152 — 2025-07-20
- 2.0.151 — 2025-07-20
- 2.0.150 — 2024-11-29
- 2.0.149 — 2024-11-17
- 2.0.148 — 2024-09-21
- 2.0.147 — 2024-09-13
- 2.0.146 — 2024-08-16
- 2.0.145 — 2024-08-04
- 2.0.144 — 2024-07-17
- 2.0.143 — 2024-07-11
- 2.0.142 — 2024-06-21
- 2.0.141 — 2024-06-18
- … 204 more at https://npm.io/package/niconizer/versions

## 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("<b>Hello, world!</b>");
```

### Browser (assuming use from userscripts such as Greasemonkey)

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

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

### 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
```

---
_Source: https://npm.io/package/niconizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._