sladro
b447fc7864
Some checks are pending
Build / build (18.x, macos-latest) (push) Waiting to run
Build / build (18.x, ubuntu-latest) (push) Waiting to run
Build / build (18.x, windows-latest) (push) Waiting to run
Build / build (20.x, macos-latest) (push) Waiting to run
Build / build (20.x, ubuntu-latest) (push) Waiting to run
Build / build (20.x, windows-latest) (push) Waiting to run
22 lines
1.1 KiB
HTML
22 lines
1.1 KiB
HTML
<h1>Installation</h1>
|
|
|
|
<p>The recommended way to install the engine is to get it as an NPM package. In some cases it's not possible, so a browser-ready bundle is available for download and add directly to a html file.</p>
|
|
|
|
<h2>Install from NPM (recommended)</h2>
|
|
|
|
<p>The engine is available as an NPM package called <a href="https://www.npmjs.com/package/online-3d-viewer" target="_blank">online-3d-viewer</a>. The package itself is an ES6 module, so it can be used with several different bundlers.</p>
|
|
|
|
<p>You can install it by running the following command.</p>
|
|
|
|
<pre><code class="language-plaintext">npm install online-3d-viewer</code></pre>
|
|
|
|
<p>After installation you can import it like any other packages.</p>
|
|
|
|
<pre><code class="language-js">import * as OV from 'online-3d-viewer';</code></pre>
|
|
|
|
<h2>Download as browser-ready bundle</h2>
|
|
|
|
<p>A bundle is available for every release. Download the zip file generated by your release process, copy the content to your server, and include the main file on your site.</p>
|
|
|
|
<pre><code class="language-html"><script type="text/javascript" src="o3dv.min.js"></script></code></pre>
|