Before getting started we recommend you install Nodejs (if you don't have it already)
After having installed the tools listed above you might have to restart your machine once!
Needle Engine with Unity
We support Unity 2021 and 2022 LTS
Drop the downloaded .unitypackage file into a Unity project (or double click to open) and confirm that you want to import it.
Wait for the installation and import to finish.
A window may open stating that "A new scoped registry is now available in the Package Manager.". This is our Needle Package registry where packages are downloaded from. You can safely close that window and continue with the next step below.
Option 1: Explore Samples
Select Needle Engine > Explore Samples to view, open and modify all available sample scenes.
Option 2: Create a new scene from a template
Select File > New Scene and choose from one of the Needle templates.
We recommend the Collaborative Sandbox template which is a great way to get started with interactivity, multiplayer,and adding assets.
Video: Starting from a fresh Unity project
Create a new scene from a Scene Template
We provide a number of Scene Templates for quickly starting new projects.
These allow you to go from idea to prototype in a few clicks.
- Click on
File > New Scene
- Select one of the templates with (needle) in their name and click
- Click Play to install and startup your new web project.
Create a new scene from scratch
If you don't want to start from a scene template, you can follow these steps.
Effectively, we're going to recreate the "Minimal (Needle)" template that's shipping with the package.
Create a new empty scene
Set up your scene for exporting
Add an empty GameObject, name it "Exporter" and add an
ExportInfocomponent to it.
In this component you create and quickly access your exported runtime project.
It also warns you if any of our packages and modules are outdated or not locally installed in your web project.
By default, the project name matches the name of your scene. If you want to change that, you can enter a
Directory Name where you want to create your new runtime project. The path is relative to your Unity project.
Choose a web project template Now, select a web project template for your project. The default template is based on Vite, a fast web app bundler.
Click Play to install and start your new web project
Needle Engine with Blender
We support Blender 3.6 and Blender 4.0
With Needle Engine for Blender you can build fully interactive 3D websites running on three.js.
They can easily deployed to the web and get optimized automatically by the Needle Engine Build Pipeline (needs Node.js installed)
- The Blender addon is downloaded as a zip file.
- In Blender go to
File / Settings / Add-onsand click the
- Then select the downloaded zip to install it.
Continue reading Needle Engine for Blender for a full feature list and instructions
Needle Engine without Editor
Needle Engine is built ontop of three.js. If you just want to work with the Needle Engine runtime and don't want to use any Editor integration just yet then go ahead and install it from npm by running:
npm i @needle-tools/engine
To quickly test Needle Engine in the browser use engine.needle.tools/new
It creates a new project on StackBlitz
Alternatively you can add a prebundled version of Needle Engine to your website:
https://unpkg.com/@needle-tools/engine/dist/needle-engine.light.min.js no physics module
The local website shows a warning: website not secure
You might see a warning in your browser about SSL Security depending on your local configuration.
This is because while the connection is encrypted, by default there's no SSL certificate that the browser can validate.
If that happens: click
Proceed to Site. Now you should see your scene in the browser!
Something is not working as expected? Where can I see logs?
Keep an eye for console warnings! We log useful details about recommended project settings and so on. For example, your project should be set to Linear color space (not Gamma), and we'll log an error to the Unity console if that's not the case.
Please also have a look at our FAQ if your question is not answered here.
- Exporting 3D objects and content
- Project Structure
- Deploy your website to the web
- Typescript Essentials
- Needle Engine for Unity Developers
- Scripting Reference