Skip to content

Commit 9c24b99

Browse files
committed
Blender docs update
1 parent bd463c3 commit 9c24b99

4 files changed

Lines changed: 130 additions & 165 deletions

File tree

documentation/blender/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ Hover over any property to see its description.
7474
- `HoverAnimation` - Plays animation on pointer hover enter/exit events
7575
- `ScrollFollow` - Move objects based on scroll position
7676
- `EverywhereActions` - Trigger actions on various events (click, hover, collision, etc.)
77+
- [Learn more about interactivity →](/docs/how-to-guides/scripting/)
7778

7879
**UI & UX:**
7980
- `Button` - Interactive buttons
80-
- `Canvas` - UI container
8181

8282
**Multimedia:**
8383
- `VideoPlayer` - Play video files and streams
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: Environment Lighting in Blender
3+
description: Set up environment lighting and skyboxes in Blender for the web — with automatic compression for fast loading
4+
---
5+
6+
# Environment Lighting
7+
8+
Set up environment lighting and skyboxes in Blender and export them to the web. Use any HDRI you want — Needle Engine automatically compresses it for fast loading and low memory usage.
9+
10+
<video-embed limit_height max_height="300px" src="/docs/blender/environment.mp4" />
11+
12+
---
13+
14+
## Quick Start
15+
16+
### Step 1: Assign an Environment Map
17+
18+
1. Open **Viewport Shading** options (top right of the 3D viewport)
19+
2. Assign an HDRI / EXR cubemap
20+
3. Set `World Opacity` to **1** to make the skybox visible in the browser
21+
22+
![Environment settings](/blender/environment.webp "2x")
23+
24+
### Step 2: Use a Custom HDRI
25+
26+
You can use any `.exr` or `.hdr` file — including large, high-resolution environment maps. Needle Engine takes care of compressing them for you during the build.
27+
28+
<video-embed limit_height max_height="300px" src="/docs/blender/custom_hdri.mp4" />
29+
30+
**Where to find free HDRIs:**
31+
- [Needle HDR Library](https://cloud.needle.tools/hdris) — Free, ready-to-use environments
32+
- [Poly Haven](https://polyhaven.com/hdris) — Hundreds of free CC0 HDRIs
33+
- [ambientCG](https://ambientcg.com/) — Free PBR materials and HDRIs
34+
35+
---
36+
37+
## Automatic Compression (FastHDR)
38+
39+
You don't need to worry about environment map file sizes. When you **build your project** or **deploy to Needle Cloud**, Needle Engine automatically converts your environment maps into the [FastHDR](/docs/fasthdr) format. This means:
40+
41+
- **Use any size** — 2K, 4K, or larger HDRIs all work great
42+
- **Automatic compression** — files get dramatically smaller (e.g. a 21 MB EXR becomes ~7 MB)
43+
- **Fast loading** — environments load in milliseconds instead of seconds
44+
- **Low memory usage** — uses up to 21x less GPU memory than raw EXR
45+
- **Same visual quality** — your lighting and reflections look identical
46+
47+
This all happens behind the scenes during the build step — no manual work required.
48+
49+
:::tip Preview compressed results locally
50+
Want to see how your scene looks with compression applied? Enable **Auto Compress** in the Needle Engine dropdown above the viewport. This gives you a local preview of the optimized result.
51+
:::
52+
53+
---
54+
55+
## Environment Camera
56+
57+
By default, the environment map is used for both **lighting** (reflections and ambient light) and the **background** (the visible skybox).
58+
59+
You can control the background appearance separately using the environment camera settings.
60+
61+
![Environment camera settings](/blender/environment-camera.webp "2x")
62+
63+
---
64+
65+
## Tips
66+
67+
**Quality:**
68+
- Higher-resolution HDRIs (4K+) give sharper reflections, especially on glossy surfaces
69+
- FastHDR compression preserves quality — don't downscale your source files
70+
71+
**Performance:**
72+
- FastHDR environments load fast even on mobile devices and low-end hardware
73+
- If you don't need a visible skybox, you can still use an HDRI for lighting only by setting `World Opacity` to **0**
74+
75+
**Troubleshooting:**
76+
- If colors look off, check your [Color Management settings](/docs/blender/#fix-color-management) — set `View` to **Standard**
77+
- If your scene has a greenish tint after building, see the [FAQ](/docs/reference/faq#why-does-my-blender-scene-have-a-green-tint-or-different-color-after-building-deploying-to-needle-cloud)
78+
79+
---
80+
81+
## Next Steps
82+
83+
- **[FastHDR Deep Dive](/docs/fasthdr)** — Learn more about how environment compression works
84+
- **[Lightmapping](/docs/blender/lightmapping)** — Combine environment lighting with baked lightmaps
85+
- **[Optimization Guide](/docs/how-to-guides/optimization/)** — More ways to optimize your scenes for the web
86+
87+
---
88+
89+
**Need Help?**
90+
- [Discord Community](https://discord.needle.tools) - Ask questions about environment setup
91+
- [Forum](https://forum.needle.tools) - Share your projects and get feedback

documentation/blender/index.md

Lines changed: 30 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,29 @@ Download and **open any sample `.blend` file** in Blender. These samples show wh
106106
When you save your `.blend` file, Needle Engine automatically re-exports your scene and refreshes the browser. This hot reload makes iteration super fast!
107107
:::
108108

109-
:::tip AI for Blender
110-
Needle already lets you use AI with Blender. Connect Claude, Copilot, Cursor, or OpenAI/Codex through Needle MCP to search your scene hierarchy, inspect selected objects, materials, and components, read project context, and even select objects in Blender. You can also launch Needle Cloud AI directly from Blender with the built-in `Ask AI about Project` action. [Learn more about Needle MCP →](/docs/ai/needle-mcp-server)
109+
:::tip AI-Assisted Workflow
110+
Need help with Needle Engine while working in Blender? Connect AI coding assistants like Claude, Copilot, or Cursor through Needle MCP — they can search your scene hierarchy, inspect objects and materials, read project context, and help you write components. You can also use the built-in `Ask AI about Project` action to get answers directly in Blender. [Learn more about Needle MCP →](/docs/ai/needle-mcp-server)
111111
:::
112112

113113
---
114114

115-
## Step 3: Add Basic Interactivity
115+
## Step 3: Set Up Environment Lighting
116+
117+
Your HDRI environment is automatically exported and used for lighting — objects in your scene will reflect it and receive ambient light from it. The visible background is separate: it can show the skybox or render as a solid color.
118+
119+
**To set up your environment:**
120+
1. Open **Viewport Shading** options (top right of 3D viewport)
121+
2. Assign an HDRI cubemap
122+
3. Optionally, set `World Opacity` to **1** to also show it as the background skybox
123+
<video-embed limit_height max_height="300px" src="/docs/blender/environment.mp4" />
124+
125+
**✓ Checkpoint:** Save and check the browser — your scene should now have environment lighting (and a visible skybox if you set World Opacity to 1)!
126+
127+
**[Learn more about environment lighting →](/docs/blender/environment)** — custom HDRIs, automatic compression for fast loading, and more.
128+
129+
---
130+
131+
## Step 4: Add Basic Interactivity
116132

117133
Now let's add camera controls so users can explore your scene.
118134

@@ -144,15 +160,10 @@ Components are reusable behaviors you add to objects. Needle Engine includes 100
144160

145161
---
146162

147-
## Step 4: Configure Essential Settings
148-
149-
Before going further, let's fix two common issues.
150-
151-
### Fix Color Management
163+
## Step 5: Set Up Color Management
152164

153-
By default, Blender uses `Filmic` which makes colors look different in the browser.
165+
By default, Blender uses `Filmic` which makes colors look different in the browser. Switch to `Standard` so what you see in Blender matches the web output.
154166

155-
**To fix:**
156167
1. Go to **Render Properties** tab
157168
2. Find **Color Management** section
158169
3. Set `View` to **Standard**
@@ -161,24 +172,6 @@ By default, Blender uses `Filmic` which makes colors look different in the brows
161172

162173
**✓ Checkpoint:** Colors now match between Blender and the web!
163174

164-
### Setup Environment Lighting
165-
166-
Your HDRI environment exports automatically, but you need to make it visible.
167-
168-
**To show skybox:**
169-
1. Open **Viewport Shading** options (top right of 3D viewport)
170-
2. Assign an HDRI cubemap
171-
3. Set `World Opacity` to **1**
172-
<video-embed limit_height max_height="300px" src="/docs/blender/environment.mp4" />
173-
174-
**✓ Checkpoint:** Save and see your skybox appear in the browser!
175-
176-
:::tip Fast environment maps — use any size you want
177-
You can use large, high-quality EXR environment maps without worrying about file size or loading speed. When you build your project or deploy to Needle Cloud, Needle Engine automatically compresses your environment into the [FastHDR](/docs/fasthdr) format — making it dramatically smaller and faster to load while keeping the same visual quality. This happens behind the scenes, no extra steps needed.
178-
179-
Want to preview the compressed result locally? Enable **Auto Compress** in the Needle Engine dropdown above the viewport.
180-
:::
181-
182175
---
183176

184177
## What You've Learned
@@ -195,66 +188,16 @@ Your Blender scenes are now running on the web with hot reload!
195188

196189
## Next Steps
197190

198-
### Continue Learning (Tutorials)
199-
200191
**[For Blender Artists →](/docs/tutorials/fundamentals/for-blender-artists)**
201-
Comprehensive guide for 3D artists covering what you can create without code, workflow tips, and when you might want scripting.
202-
203-
**[TypeScript Essentials →](/docs/tutorials/fundamentals/typescript-essentials)**
204-
Learn TypeScript basics to create custom interactive behaviors.
205-
206-
---
207-
208-
### Add More Interactivity (How-To Guides)
209-
210-
Now that you have the basics, explore specific features:
211-
212-
**[Animation Workflows →](/docs/blender/animation)**
213-
Learn all animation methods: simple Animation component, AnimatorController state machines, and PlayableDirector timeline export.
214-
215-
**[Components Guide →](/docs/blender/components)**
216-
Master the 100+ built-in components and learn to create your own custom TypeScript components.
217-
218-
**[Lightmapping →](/docs/blender/lightmapping)**
219-
Bake photorealistic lighting for stunning visuals with great performance.
220-
221-
**[Use Physics →](/docs/how-to-guides/scripting/use-physics)**
222-
Add rigidbodies, colliders, forces, and raycasting — built-in Rapier physics, no setup needed.
223-
224-
**[Add Multiplayer →](/docs/how-to-guides/networking/)**
225-
Real-time networking with voice chat, synchronized state, and zero server configuration.
226-
227-
**[Optimization & Progressive Loading →](/docs/how-to-guides/optimization/)**
228-
Production builds automatically generate mesh LODs, texture LODs, and apply compression — your scenes load instantly and stream in detail on demand. You can override compression format, max size, and LOD settings per texture in **Properties → Material tab → Needle Material Settings**.
229-
230-
**[Deploy Your Project →](/docs/how-to-guides/deployment/)**
231-
Publish your interactive scene to the web for everyone to see.
232-
233-
**[Enable WebXR →](/docs/how-to-guides/xr/)**
234-
Add VR and AR support to your scenes.
235-
236-
---
237-
238-
### Look Things Up (Reference)
239-
240-
**[Component Catalog →](/docs/reference/components)**
241-
Browse all 100+ built-in components with descriptions and settings.
242-
243-
**[API Documentation →](https://engine.needle.tools/docs/api/)**
244-
Complete TypeScript API reference for advanced development.
245-
246-
**[FAQ →](/docs/reference/faq)**
247-
Common questions and troubleshooting.
248-
249-
---
250-
251-
### Get Inspired
252-
253-
**[Sample Projects →](https://engine.needle.tools/samples)**
254-
Explore interactive examples to see what's possible.
255-
256-
**[Download More Samples →](https://engine.needle.tools/downloads/blender/download-samples)**
257-
Get working `.blend` files to learn from.
192+
Comprehensive guide covering what you can create without code, workflow tips, and when you might want scripting.
193+
194+
- [Environment Lighting →](/docs/blender/environment) — custom HDRIs, skybox settings, and automatic compression
195+
- [Animation →](/docs/blender/animation) — playback, state machines, and timeline export
196+
- [Components →](/docs/blender/components) — 100+ built-in behaviors and creating your own
197+
- [Lightmapping →](/docs/blender/lightmapping) — baked lighting for stunning visuals with great performance
198+
- [Deploy Your Project →](/docs/how-to-guides/deployment/) — publish to Needle Cloud or self-host
199+
- [Sample Projects →](https://engine.needle.tools/samples) — interactive examples to learn from
200+
- [FAQ →](/docs/reference/faq) — common questions and troubleshooting
258201

259202
---
260203

documentation/tutorials/fundamentals/for-blender-artists.md

Lines changed: 8 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -262,82 +262,13 @@ There's a friendly Discord community, extensive documentation, video tutorials,
262262

263263
---
264264

265-
## Getting Started
266-
267-
Ready to bring your 3D art to the web?
268-
269-
### Installation (5 minutes)
270-
271-
1. **Install Blender Add-on**
272-
- [Download Needle Engine for Blender](https://engine.needle.tools/downloads/blender?utm_source=needle_docs&utm_content=getting_started)
273-
- Install like any Blender add-on
274-
- Activate in Preferences
275-
276-
2. **Download Sample Projects**
277-
- [Download Blender Samples](https://engine.needle.tools/downloads/blender/download-samples?utm_source=needle_docs&utm_content=blender)
278-
- Open sample .blend files to see working examples
279-
- Modify and experiment!
280-
281-
3. **Start Creating**
282-
- Begin with a simple scene
283-
- Add Needle components from the side panel
284-
- Click "Play in Browser" to preview
285-
286-
:::tip Start Small
287-
Don't start with your most complex scene. Begin with something simple to learn the workflow, then level up!
288-
:::
289-
290-
### Learning Resources
291-
292-
**For Visual Learners:**
293-
- [Video Tutorials](https://www.youtube.com/@needle-tools) - Step-by-step guides
294-
- [Sample Projects](https://engine.needle.tools/samples) - Explore working examples
295-
- [Live Demos](https://samples.needle.tools/#showcase) - See what's possible
296-
297-
**For Reading:**
298-
- [Blender Integration Guide](/docs/blender/) - Complete Blender workflow
299-
- [Component Reference](/docs/reference/components) - All built-in components
300-
- [How-To Guides](/docs/how-to-guides/) - Specific tasks
301-
302-
**Community:**
303-
- [Discord Community](https://discord.needle.tools) - Ask questions, share work
304-
- [Forum](https://forum.needle.tools) - Discussions and examples
305-
- [Samples & Showcase](https://samples.needle.tools/#showcase) - Get inspired
306-
307-
---
308-
309-
## Inspiration: What Will You Create?
310-
311-
Needle Engine gives you **superpowers** as a 3D artist:
312-
313-
- 🎨 Your art becomes **interactive and alive**
314-
- 🌐 Reaches **anyone, anywhere, instantly**
315-
- 📱 Works on **every device automatically**
316-
- 🥽 Supports **VR and AR natively**
317-
- ⚡ Loads **fast and runs smoothly**
318-
319-
Whether you're showcasing your portfolio, creating client work, building an art installation, or just exploring creative possibilities—Needle Engine makes your 3D work accessible to the world.
320-
321-
**The best part?** You don't need to be a programmer. You're a 3D artist, and that's exactly what Needle Engine needs.
322-
323-
---
324-
325265
## Next Steps
326266

327-
Start your journey:
328-
329-
1. **Install the Add-on** - [Download from needle.tools](https://needle.tools)
330-
2. **Watch a Quick Start Video** - [YouTube](https://www.youtube.com/@needle-tools)
331-
3. **Open a Sample Project** - See working examples in Blender
332-
4. **Join the Community** - [Discord](https://discord.needle.tools) for help and inspiration
333-
5. **Create Something Amazing** - Your first interactive 3D experience!
334-
335-
:::tip Share Your Work!
336-
When you create something, share it in the Discord! The community loves seeing what artists create, and you'll get helpful feedback and encouragement.
337-
:::
338-
339-
---
340-
341-
**Ready to bring your 3D art to life on the web? Let's go! 🚀**
342-
343-
[Install Needle Engine →](https://needle.tools)[Watch Video Tutorial →](https://www.youtube.com/@needle-tools)[Join Discord →](https://discord.needle.tools)
267+
- [Get Started with Blender →](/docs/blender/) — install the add-on and create your first project
268+
- [Environment Lighting →](/docs/blender/environment) — custom HDRIs, skybox settings, and automatic compression
269+
- [Animation →](/docs/blender/animation) — playback, state machines, and timeline export
270+
- [Components →](/docs/blender/components) — 100+ built-in behaviors and creating your own
271+
- [Lightmapping →](/docs/blender/lightmapping) — baked lighting for stunning visuals with great performance
272+
- [Deploy Your Project →](/docs/how-to-guides/deployment/) — publish to Needle Cloud or self-host
273+
- [Sample Projects →](https://engine.needle.tools/samples) — interactive examples to learn from
274+
- [FAQ →](/docs/reference/faq) — common questions and troubleshooting

0 commit comments

Comments
 (0)