Files Used to Run the Website

All the files indicated in this section are located inside the web/public folder. The local server uses the files in the root web folder when starting the sample.

index.html

This is the main page for the website. The command genvid-sdk open web displays it. This document includes various JavaScript and CSS files.

unity.ts

This is a TypeScript file which creates a JavaScript file included in the index.html and admin.html documents. It performs all calls to the Genvid API and other interactions on the index page.

css folder

This folder contains icons.css and style.css. The cheer button requires icons.css while style.css defines all the other style options for index.html and admin.html.

img folder

This folder contains the images used for the website. The circle highlight made in WebGL, the Genvid logo, and the Genvid overlay-button all use images from the img folder.

js folder

This folder contains the JavaScript and map files generated by running the py unity.py build command. The map files are for the TypeScript files: adminUnity.ts, genvid.d.ts, and unity.ts. You make changes to the TypeScript files, but include the JavaScript files in the HTML document.

admin.html

This page is the admin section for the website. It contains several buttons that allow direct interaction with the game objects.

The admin page requires a username and password. The default user name is admin and the password is admin.

adminUnity.ts

This is a TypeScript file which creates a JavaScript file included in the admin.html document. It does all the calls to the Genvid API and other interactions on the admin page.

favicon.icon

This is an icon for the webpage.

tsconfig.json

This is a file needed for building the TypeScript files. Add the TypeScript files that you need to build in the include section of this file.

tslint.json

This is a file needed for building the TypeScript files. It formats the JavaScript created with the TypeScript files.

webpack.config.js

The webpack configuration tells Webpack how to bundle the Unity app.