Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felixmariotto/three-mesh-ui
⏹ Make VR user interfaces for Three.js
https://github.com/felixmariotto/three-mesh-ui
Last synced: 25 days ago
JSON representation
⏹ Make VR user interfaces for Three.js
- Host: GitHub
- URL: https://github.com/felixmariotto/three-mesh-ui
- Owner: felixmariotto
- License: mit
- Created: 2020-04-22T16:01:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-03T22:11:05.000Z (11 months ago)
- Last Synced: 2024-04-14T13:11:03.415Z (7 months ago)
- Language: JavaScript
- Homepage: https://felixmariotto.github.io/three-mesh-ui/#basic_setup
- Size: 16.4 MB
- Stars: 1,221
- Watchers: 23
- Forks: 128
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - three-mesh-ui - VR user interfaces for Three.js. (Libraries / JavaScript)
README
# three-mesh-ui
## [Examples (live)](https://felixmariotto.github.io/three-mesh-ui/) | [NPM](https://www.npmjs.com/package/three-mesh-ui) | [Documentation](https://github.com/felixmariotto/three-mesh-ui/wiki) | [Contributing](https://github.com/felixmariotto/three-mesh-ui/wiki/Roadmap-&-Contributions)
📢 7.x.x is in evaluation, check it out here https://github.com/felixmariotto/three-mesh-ui/pull/223
# What is it ?
**three-mesh-ui** is a small library for building VR user interfaces. The objects it creates are [three.object3Ds](https://github.com/mrdoob/three.js/blob/dev/src/core/Object3D.js), usable directly in a [three.js](https://threejs.org) scene like any other Object3D.
**It is not a framework**, but a minimalist library to be used with the last version of three.js. It has no dependency but three.js.
# Why ?
In a normal three.js workflow, the common practice is to build user interfaces with HTML/CSS.
In immersive VR, it is impossible, therefore this library was created.
# Quick Start
## Try it now
Give it a try in [this jsFiddle](https://jsfiddle.net/felixmariotto/y81rf5t2/44/)
Using react-three-fiber ? Here is a [codesandbox](https://codesandbox.io/s/react-three-mesh-ui-forked-v7n0b?file=/src/index.js) to get started.
## Import
### JSM
#### With NPM
`npm install three-mesh-ui`
*:warning: It requires three as peer dependency*
##### ES6 ([codesandbox demo](https://codesandbox.io/s/npm-package-demo-2onzpo))
```javascript
import ThreeMeshUI from 'three-mesh-ui'
```
##### CommonJS
```javascript
const ThreeMeshUI = require('three-mesh-ui');
```
##### HTML <script> tag ([codesandbox demo](https://codesandbox.io/s/module-build-demo-bkmfi8?file=/index.html:281-913))
```html
{
"imports": {
"three": "https://unpkg.com/[email protected]/build/three.module.js",
"three-mesh-ui": "https://unpkg.com/[email protected]/build/three-mesh-ui.module.js"
}
}
import * as THREE from "three";
import * as ThreeMeshUI from "three-mesh-ui";
// code goes here ...
```
:muscle: *You can use the minified version named __three-mesh-ui.module.min.js__ ([codesandbox demo](https://codesandbox.io/s/module-build-demo-minified-pm6jwx))*
### JS
#### HTML <script> tag ([codesandbox demo](https://codesandbox.io/s/js-build-demo-061eku))
```html
/* global THREE, ThreeMeshUI */
// code goes here ...
```
:muscle: *You can use the minified version named __three-mesh-ui.min.js__ ([codesandbox demo](https://codesandbox.io/s/js-build-demo-minified-onh8zi))*
:warning: *Although this would theorically allows you to build 'something', loading js libraries instead of using jsm, might restrict the global features you would have. This is true for both three and three-mesh-ui libraries.*
## Font files
In order to display some text with three-mesh-ui, you will need to provide font files.
You can use the two files named `Roboto-msdf` in [this directory](https://github.com/felixmariotto/three-mesh-ui/tree/master/examples/assets), or [create your own font files](https://github.com/felixmariotto/three-mesh-ui/wiki/Creating-your-own-fonts)
## API
Here is an example of basic three-mesh-ui usage :
```javascript
const container = new ThreeMeshUI.Block({
width: 1.2,
height: 0.7,
padding: 0.2,
fontFamily: './assets/Roboto-msdf.json',
fontTexture: './assets/Roboto-msdf.png',
});
//
const text = new ThreeMeshUI.Text({
content: "Some text to be displayed"
});
container.add( text );
// scene is a THREE.Scene (see three.js)
scene.add( container );
// This is typically done in the render loop :
ThreeMeshUI.update();
```