Grimoire doesn’t support IE11 and below. Please use Microsoft Edge instead.
(Possibly works fine on IE11.)
Chrome, Firefox, Safari, Chrome on Android and iPhone safari would works fine.
Caution of WebGL extension Compatibility
Some of plugin may require some extension of WebGL or some specific texture size at least to work.
You can see webglstats.com to check compatibility of WebGL extensions.
All release notes for core library and official plugins are available on Github.
You can simply download and link with
gr will be registered as global variable.
Download link via unpkg.com
The package named
preset-basicis starter set of Grimoire.js. This includes some plugins most of developers need to use.
This contains this packages below.
- grimoirejs (Core package)
- grimoirejs-math (3DGraphics math library)
- grimoirejs-fundamental (Minimal renderer components)
Grimoire is component oriented framework. Every features represented as tags and components are implemented as plugins.
These plugins register some components and nodes to enable us to use them.
In many case, you need to use another plugins for your work. You can just link them after the
This is official package lists maintained.
Downalod link via unpkg.com
- grimoirejs-gltf(Model loader plugin for
- grimoirejs-forward-shading(Typical shading plugin)
These are linking to the newest version. To prevent breaking your work by our update, make sure the versions are fixed.
<script> tag instead of using npm.
All of the packages can be installed with npm.
$ npm install grimoirejs-preset-basic --save
The other packages are also provided via npm in same way.
If you want to bundle all of files including grimoirejs, you need to call
/register file first.
const gr = require("grimoirejs-preset-basic/register");
import gr from "grimoirejs-preset-basic/register";
This code will register all tags to prepare to use.
What will occur when import without
The code called by
registeris including actual grimoirejs code to be bundled.
The require code without
require('grimoirejs-preset-basic')) is just referencing GrimoireJS variable which is global reference to Grimoire.js
This is used for fetching grimoire interface from npm without accessing global variable and linking actual grimoire.js code with