Open Model Interface

(Omi)

Open-source replacement for Sketchfab for hosting 3D models for Galleries, Libraries, Archives, and Museums

Host your 3D Models on GitHub pages for free for small collections, or self-host for larger.

Under development by the Boston College Libraries Digital Scholarship Group

Installation

Step 1 - Clone the Repo

git clone https://github.com/BCDigSchol/omi

Step 2 - Place Your Models

# put all your models in the following directory (obj, gltf, glb)
/public/models/

Step 3 - Put Your Metadata in Place

# Put a CSV with your metadata in the following folder (called whatever you want)
/public/

You must at least have the columns of "id" "title" and "filename", and "filename" must correspond to a filename inside the /public/models folder

Step 4 - Edit the Config File

# Edit the configuration file at
/src/_config.ts

Change the config file to reflect your project needs, including name and authorship. If hosting on Github, make sure projectName matches the name of the repo you plan to store this in in your local account.

Step 5 - Change the Base HREF (if hosting online)

Start by editing the html file at /src/index.html

Find the line

<base href="/">

And replace / with the full web address of wherever you are hosting this (e.g. https://example.github.io/omi/)

Step 6 - Enable GH pages hosting

If you want to host this on GH pages... head to the repository settings, go to the Pages tab, and choose Source: Deploy from branch. Then choose gh-pages for the branch and hit save. Your site should deploy after a few minutes at yourusername.github.io/yourreponame