Skip to content

๐Ÿ“š Stand-alone library of threejs examples designed to run without transpilation in node & browser

License

Notifications You must be signed in to change notification settings

pmndrs/three-stdlib

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

three-stdlib

Version Downloads Twitter Discord release

Stand-alone version of threejs/examples/jsm written in Typescript & built for ESM & CJS.

Basic usage

npm install three-stdlib
// Export collection
import * as STDLIB from 'three-stdlib'
// Flatbundle
import { OrbitControls, ... } from 'three-stdlib'

Problem

three/examples are usually regarded as something that you copy/paste into your project and adapt to your needs. That's not how people use it, and this has caused numerous issues in the past.

Solution

  • A build system for ESM and CJS, compatible with browser, workers, and Node
  • Class based, optimized for tree-shaking, no globals, exports instead of collections
  • Typesafety with simple annotation-like types
  • SemVer and NPM managed dependencies

But most importantly, allowing more people that use and rely on these primitives to hold a little stake, and to share the weight of maintaining it.

How to Contribute

  1. Fork and clone the repo
  2. Run yarn install to install dependencies
  3. Create a branch for your PR with `git checkout -b pr-type/issue-number-your-branch-name beta
  4. Let's get cooking! ๐Ÿ‘จ๐Ÿปโ€๐Ÿณ๐Ÿฅ“

Commit Guidelines

Be sure your commit messages follow this specification: https://conventionalcommits.org/en/v1.0.0-beta.4

Publishing

We use semantic-release-action to deploy the package. Because of this only certain commits will trigger the action of creating a release:

  • chore will not release a new version
  • fix: will create a 0.0.x version
  • feat: will create a 0.x.0 version
  • BREAKING CHANGE: will create a x.0.0 version