opusgl
A minimal rendering library.
Warning: This library is a collection of years of experimental work with a playground for features and APIs fielded for three.js, react-three-fiber, OGL, and react-ogl. I do not intend to ship it in its current form, so I'm open-sourcing it as a learning resource in the meantime.
Table of Contents
Install
This assumes you already have Node installed and a build system configured. If you're just getting started, I'd recommend using Vite or Codesandbox and continuing with NPM.
via NPM
Install from NPM with:
npm install opusgl
# or, if you use Yarn
yarn add opusgl
via CDN
If you'd prefer to not use build tools and use a CDN, I'd recommend Skypack as it bundles things for you.
Make sure you specify a fixed version (opusgl@0.0.1
) so your code doesn't break down the line.
<script type="module">
import { WebGLRenderer, Program, Vector3, Color } from 'https://cdn.skypack.dev/opusgl'
</script>
Contributing
This project uses semantic commits and semver.
Make sure you have Node and Yarn and installed. Install dependencies with:
yarn
Development
Locally run examples against the library with:
yarn dev
Publishing
To publish a release on NPM, run the following and follow the dialog:
yarn release