rnsrk/dfg_3dviewer_js_library
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
No description
11 commits 1 branch 1 tag 22 MiB
Find a file
Exact
rsnrk 681efc2e5f with changelog and first release
2026-06-25 12:32:08 +02:00
.github/workflows no ci for package building 2026-06-25 10:28:45 +02:00
scripts Initial commit 2026-06-25 09:11:23 +02:00
src-tauri Initial commit 2026-06-25 09:11:23 +02:00
tests Initial commit 2026-06-25 09:11:23 +02:00
viewer fix the asset path resolving 2026-06-25 10:28:16 +02:00
.gitattributes rm dist, cause we have no current library to download 2026-06-25 10:05:33 +02:00
.gitignore add library.zip again 2026-06-25 10:36:42 +02:00
CHANGELOG.md with changelog and first release 2026-06-25 12:32:08 +02:00
dfg-3dviewer-library.zip add library.zip again 2026-06-25 10:36:42 +02:00
embed.html Initial commit 2026-06-25 09:11:23 +02:00
index.html Initial commit 2026-06-25 09:11:23 +02:00
jsconfig.json Initial commit 2026-06-25 09:11:23 +02:00
package-lock.json Initial commit 2026-06-25 09:11:23 +02:00
package.json Initial commit 2026-06-25 09:11:23 +02:00
playwright.config.js Initial commit 2026-06-25 09:11:23 +02:00
README.md update readme 2026-06-25 11:04:39 +02:00
rollup.config.js Initial commit 2026-06-25 09:11:23 +02:00
viewer-settings-example.json Initial commit 2026-06-25 09:11:23 +02:00

README.md

DFG 3D Viewer — JavaScript Library

Three.js-based 3D viewer. Ships as a minified bundle for web/libraries/dfg-3dviewer/ or standalone HTML embeds.

Drupal integration is provided by the separate dfg_3dviewer module.

Build and package

npm install
npm run build:library
npm run pack:library

Output:

  • dist/library/ — dfg_3dviewer.min.js and assets/ (CSS, draco, IFC WASM, fonts)
  • dfg-3dviewer-library.zip — extract to web/libraries/dfg-3dviewer/ on Drupal (gitignored)

Local development

cp viewer/viewer-settings-example.json viewer-settings.json
npm run dev:test
# http://localhost:1234

Install on Drupal

  1. Install the library to web/libraries/dfg-3dviewer/ — either build locally (see above) and extract dfg-3dviewer-library.zip, or download a release prebuild.

    Latest release:

    curl -fL "https://gitlab.nasarek.dev/rnsrk/dfg_3dviewer_js_library/-/releases/permalink/latest/downloads/dfg-3dviewer-library.zip" -o /tmp/dfg-3dviewer-library.zip
mkdir -p web/libraries/dfg-3dviewer
unzip -o /tmp/dfg-3dviewer-library.zip -d web/libraries/dfg-3dviewer
rm /tmp/dfg-3dviewer-library.zip

    Pin a version (replace 0.0.1 with the tag you need):

    curl -fL "https://gitlab.nasarek.dev/rnsrk/dfg_3dviewer_js_library/-/releases/0.0.1/downloads/dfg-3dviewer-library.zip" -o /tmp/dfg-3dviewer-library.zip
mkdir -p web/libraries/dfg-3dviewer
unzip -o /tmp/dfg-3dviewer-library.zip -d web/libraries/dfg-3dviewer
rm /tmp/dfg-3dviewer-library.zip

    Run from your Drupal project root (e.g. /opt/drupal).

  2. Enable the dfg_3dviewer Drupal module and configure at /admin/config/dfg_3dviewer

Standalone embed

<div id="DFG_3DViewer" 3d="./examples/box.stl"></div>
<script type="module" src="./dfg_3dviewer.min.js"></script>

Or pass config in code: await Viewer.MainInit({ ... }).

Repository layout

  • viewer/ — source
  • dist/ — build output (gitignored; run npm run build:library)
  • rollup.config.js — production builds
  • tests/ — Playwright E2E