# Packages

Canonical: https://docs.shumoku.dev/ja/library/packages
Language: ja

libs/README.md

# Packages

The Shumoku engine, renderers, supporting packages, and data-source plugins.

日本語版はまだありません。英語の原文を表示しています。

The Shumoku libraries — the rendering engine, its supporting packages, and the data-source plugins.

## Core engine & renderers

| Package | What it is |
| --- | --- |
| [`shumoku`](https://docs.shumoku.dev/ja/library) | All-in-one — re-exports core + the SVG/HTML renderers. Start here. |
| [`@shumoku/core`](https://docs.shumoku.dev/ja/library/packages/core) | Models, YAML parser, layout engine, themes, plugin kit. Browser-safe and render-agnostic. |
| [`@shumoku/renderer-svg`](https://docs.shumoku.dev/ja/library/packages/renderer-svg) | SVG render pipeline (`prepareRender` → `renderSvg`). |
| [`@shumoku/renderer-html`](https://docs.shumoku.dev/ja/library/packages/renderer-html) | Interactive HTML output. |
| [`@shumoku/renderer-png`](https://docs.shumoku.dev/ja/library/packages/renderer-png) | PNG output (Node.js, via resvg). |
| [`@shumoku/renderer`](https://docs.shumoku.dev/ja/library/packages/renderer) | Svelte interactive renderer (pan/zoom, serialization) — used by the editor and the server web UI. |
| [`@shumoku/catalog`](https://docs.shumoku.dev/ja/library/packages/catalog) | Device / service catalog (vendor, model, SNMP sysObjectID). |
| [`@shumoku/plugin-sdk`](https://docs.shumoku.dev/ja/library/packages/plugin-sdk) | Node HTTP client + pagination for data-source plugins. |

## Data-source plugins

[`plugins/`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins) — each implements `DataSourcePlugin` and translates its upstream vocabulary into core’s neutral types at the boundary:

| Plugin | Capabilities |
| --- | --- |
| [`zabbix`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/zabbix) | metrics, hosts, topology, alerts |
| [`prometheus`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/prometheus) | metrics, hosts, alerts |
| [`netbox`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/netbox) | topology, hosts |
| [`grafana`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/grafana) | alerts |
| [`aruba-instant-on`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/aruba-instant-on) | hosts, metrics, alerts |
| [`network-scan`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/network-scan) | autoscan (SNMP / LLDP discovery) |

See [Plugin Authoring](https://docs.shumoku.dev/ja/developers/plugin-authoring) to write your own.
