90 lines
5.0 KiB
HTML
90 lines
5.0 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
|
<meta name="viewport" content="width=device-width, user-scalable=no">
|
|
<link rel="icon" type="image/png" href="static/3dviewer_net_favicon.ico">
|
|
|
|
<title>Online 3D Viewer - Installation</title>
|
|
|
|
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
|
|
<script src="static/highlightjs/highlight.min.js"></script>
|
|
|
|
<link rel="stylesheet" type="text/css" href="static/style.css"/>
|
|
<script type="text/javascript" src="static/script.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
|
|
<div id="navigation" class="navigation thin_scrollbar">
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Pages</div>
|
|
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
|
|
<div id="nav-GitHub" class="navigation_item"><a href="https://github.com/kovacsv/Online3DViewer" target="_blank">GitHub</a></div>
|
|
</div>
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Engine Usage</div>
|
|
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
|
|
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
|
|
</div>
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Contribution</div>
|
|
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
|
|
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
|
|
</div>
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Classes</div>
|
|
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
|
|
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
|
|
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
|
|
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
|
|
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
|
|
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
|
|
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
|
|
</div>
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Functions</div>
|
|
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
|
|
<div id="nav-Init3DViewerElementFromUrlList" class="navigation_item"><a href="Function_Init3DViewerElementFromUrlList.html" target="_self">Init3DViewerElementFromUrlList</a></div>
|
|
<div id="nav-Init3DViewerElementFromFileList" class="navigation_item"><a href="Function_Init3DViewerElementFromFileList.html" target="_self">Init3DViewerElementFromFileList</a></div>
|
|
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
|
|
</div>
|
|
<div class="navigation_section">
|
|
<div class="navigation_title">Enums</div>
|
|
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
|
|
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="main" class="main">
|
|
<div class="page">
|
|
<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. You need to download the zip file attached to the <a href="https://github.com/kovacsv/Online3DViewer/releases" target="_blank">latest release</a>. After that, copy the content of the zip file on 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>
|
|
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">Init ('Installation')</script>
|
|
</body>
|
|
|
|
</html>
|