Giter Club home page Giter Club logo

aframe-destiny-model-component's Introduction

aframe-destiny-model-component

Version License

Load Destiny game models from the Bungie API.

Currently handles a few global variables very bluntly. Feel free to drop an Issue or a Pull Request if you've a better idea for how to handle them.

For A-Frame.

API

Property Description Default Value
itemHash itemHash of the item you would like to load.
shaderHash itemHash of the shader you would like to apply. 0 applies default shader. 0
game Accepts destiny or destiny2 destiny2
platform Accepts web or mobile. Web seems to only work for Destiny 1 assets. Mobile requires you host manifest proxies. See the TGXLoader documentation for more info. mobile
apiKey The Bungie API Key for your app window.DESTINYMODELCONFIG.apiKey
d1Manifest Destiny Manifest proxy URL window.DESTINYMODELCONFIG.d1Manifest
d2Manifest Destiny 2 Manifest proxy URL window.DESTINYMODELCONFIG.d2Manifest

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.6.0/aframe.min.js"></script>
  <script>
    window.DESTINYMODELCONFIG = {
      apiKey: 'BUNGIE-API-KEY',
      d1Manifest: 'DESTINY-MANIFEST-URL',
      d2Manifest: 'DESTINY-2-MANIFEST-URL'
    }
  </script>
  <script src="https://unpkg.com/aframe-destiny-model-component/dist/aframe-destiny-model-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity destiny-model="itemHash: 3854359821; game: destiny2; shader: 1422712818; platform: mobile;"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-destiny-model-component

Then require and use.

require('aframe');
require('aframe-destiny-model-component');

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.