Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.09 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.09 KB

@quick-threejs/legacy

@quick-threejs/legacy is a small library. This lib was designed to quickly start a ThreeJS app. It'll set up a 3D scene with as little configuration as possible.

🚀 Quick start

Simply import @quick-threejs/legacy and instantiate it as follows:

import QuickThreejs from "@quick-threejs/legacy";

let APP = new QuickThreejs(
	{
		axesSizes: 5,
		gridSizes: 10,
		enableDebug: true,
		withMiniCamera: true
	},
	"#experience"
);

That's it! Now you should see the following screen on your local development server preview: image

Understanding

@quick-threejs/legacy is designed to be usage simple.

💡 The first parameter is the initialization properties and the second is the DOMElement reference.

For more details about the about the available properties, see:

See the complete Example folder.