@elumixor/asset-viewer
v2.0.4
Published
A simple asset viewer for PixiJS and Three.js
Readme
Asset Viewer
A simple asset viewer for PixiJS and Three.js projects.
Usage
npm install --save-dev @elumixor/asset-viewer
# Start viewer pointing directly to a directory containing .glb/.gltf/.png/.jpg/.jpeg/.webp files
npx asset-viewer ./path/to/assets
# Custom port
npx asset-viewer ./path/to/assets --port 6001
# Auto-open in browser
npx asset-viewer ./path/to/assets --openOpen your browser at the printed URL (defaults to http://localhost:5735).
The provided path can be either:
- A folder that directly contains model/texture files (served under
/assets). - A project root that contains
public/assets(that subfolder will be used).
Command line options:
Usage: asset-viewer [options] <path>
-p, --port <number> Port to run the server on (default: 5735)
-o, --open Open default browser pointing to server root after start
-V, --version Output version
-h, --help Display helpNotes:
- Client is a React + Vite bundle (Three.js + GLTF previews).
- Three.js is resolved from local
node_moduleswith standard ESM import (no inline import map).
Development (Hot Reload)
Single command dev environment with Bun hot server + Vite HMR client:
bun run dev -- ./test/assets --port 5735Details:
- Starts the asset viewer server via
bun run --hot src/asset-viewer-server.ts ...(automatic restart on changes). - Starts
vite devfor the React client (port 5173 by default) and proxies/api+/assetsto the Bun server port. - Pass any normal CLI arguments to the server after
--(path, --port, etc.).
Open the Vite dev URL it prints (e.g. http://localhost:5173) during development. For a production-like bundle, run bun run build then execute the generated CLI (npx asset-viewer ...).
