Skip to content

Commit

Permalink
fix some links, fix blender link title
Browse files Browse the repository at this point in the history
  • Loading branch information
@hybridherbst
hybridherbst committed Sep 17, 2024
1 parent 219a26c commit 664f4b8
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 35 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[![Version](https://img.shields.io/npm/v/@needle-tools/engine?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@needle-tools/engine)
[![Downloads](https://img.shields.io/npm/dt/@needle-tools/engine.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@needle-tools/engine)
[![Discord Shield](https://img.shields.io/discord/717429793926283276?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=ffffff)](https://discord.needle.tools)
[![Forum Shield](https://img.shields.io/badge/forum-forum.needle.tools-blue?style=flat&colorA=009900&colorB=000000)](https://forum.needle.tools)
</div>

<div align="center">
Expand Down
6 changes: 3 additions & 3 deletions documentation/.vuepress/config.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ export default defineUserConfig({
{
text: "Blender",
children: [
"/blender"
"/blender/"
]
},
{
Expand Down Expand Up @@ -456,7 +456,7 @@ export default defineUserConfig({
]
},
{
text: "Creating your Project",
text: "Core Concepts",
children: [
"/project-structure",
"/everywhere-actions",
Expand Down Expand Up @@ -504,7 +504,7 @@ export default defineUserConfig({
{
text: "Blender",
children: [
"/blender",
"/blender/",
]
},
]
Expand Down
33 changes: 19 additions & 14 deletions documentation/blender/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ If you have feedback for us please let us know in [our forum](https://forum.need

## Download and Installation 💿

### Step 1 • <a target="_blank" href="https://www.blender.org/download/">Install Blender</a> 3.6, 4.0, 4.1 or 4.2
### Step 1
<a target="_blank" href="https://www.blender.org/download/">Install Blender</a> 3.6, 4.0, 4.1 or 4.2

### Step 2
<ClientOnly>
### Step 2 • <os-link windows_url="https://nodejs.org/dist/v20.9.0/node-v20.9.0-x64.msi" osx_url="https://nodejs.org/dist/v20.9.0/node-v20.9.0.pkg">Install Nodejs ⭐</os-link>
<os-link windows_url="https://nodejs.org/dist/v20.9.0/node-v20.9.0-x64.msi" osx_url="https://nodejs.org/dist/v20.9.0/node-v20.9.0.pkg">Install Nodejs ⭐</os-link>
</ClientOnly>

### Step 3 • <a class="plausible-event-name=download_blender plausible-event-position=blender_download" target="_blank" href="https://engine.needle.tools/downloads/blender?utm_source=needle_docs&utm_content=blender">Download Needle Engine for Blender</a>
### Step 3
<a class="plausible-event-name=download_blender plausible-event-position=blender_download" target="_blank" href="https://engine.needle.tools/downloads/blender?utm_source=needle_docs&utm_content=blender">Download Needle Engine for Blender</a>

*The Blender addon is downloaded as a zip file.
In Blender go to `File / Settings / Add-ons` and click the `Install` button.
Expand Down Expand Up @@ -99,7 +102,7 @@ Alternatively if you don't want to see the cubemap as a background add a Camera

![Environment Camera](/blender/environment-camera.webp)

### Add your custom HDRi / EXR environment lighting and skybox
### Add your custom HDRI / EXR environment lighting and skybox

<video-embed limit_height src="/docs/blender/custom_hdri.mp4" />

Expand Down Expand Up @@ -151,16 +154,17 @@ To use an AnimatorController add an Animator component to the root object of you
You can set the Animator parameters from typescript or by e.g. using the event of a Button component


### Timeline — nla tracks export 🎬
### Timeline — NLA Tracks export 🎬

Exporting Blender nla tracks to threejs.
Add a PlayableDirector component (via `Add Component`) to a any blender object. Assign the objects in the ``animation tracks`` list in the component for which you want the nla tracks to be exported.
You can export Blender NLA tracks directly to the web.
Add a PlayableDirector component (via `Add Component`) to a any blender object. Assign the objects in the ``animation tracks`` list in the component for which you want the NLA tracks to be exported.

![](/blender/timeline_setup.webp)
![](/blender/timeline.webp)

::: details Code example for interactive timeline playback
Add this script to `src/scripts` (see custom components section) and add it to any object in Blender to make a timeline's time be controlled by scrolling in the browsers

```ts twoslash
import { Behaviour, PlayableDirector, serializable, Mathf } from "@needle-tools/engine";

Expand Down Expand Up @@ -226,16 +230,14 @@ Make sure ``@needle-tools/needle-component-compiler`` 2.x is installed in your w

## Lightmapping 💡

Needle Lightmapping will automatically generate lightmap UVs for all models marked to be lightmapped. For lightmapping to work you need at least one light and one object with `Lightmapped` turned on.

::: danger Please keep in mind:
You are using an early preview of these features - we recommend creating a backup of your blend file when using Lightmapping at this point in time. Please report problems or errors you encounter in [our discord](https://discord.needle.tools) 🙏
:::
Needle includes a lightmapping plugin that makes it very easy to bake beautiful lights to textures and bring them to the web. The plugin will automatically generate lightmap UVs for all models marked to be lightmapped, there is no need to make a manual texture atlas. It also supports lightmapping of multiple instances with their own lightmap data.
For lightmapping to work, you need at least one light and one object with `Lightmapped` turned on in the `Needle Object` panel.

<video-embed limit_height max_height="800px" src="/docs/blender/lightmapping.mp4" />

> You can download the original blend file from the video [here](https://engine.needle.tools/downloads/blender/lightmaps.blend).
::: tip
You can download the .blend file from the video [here](https://engine.needle.tools/downloads/blender/lightmaps.blend).
:::
Use the Needle Object panel to enable lightmapping for a mesh object or light:

![Lightmapping object](/blender/lightmapping-object.webp)
Expand All @@ -248,6 +250,9 @@ Alternatively you can also use the Lightmapping panel in the `Render Properties`

![Lightmapping object](/blender/lightmapping-panel.webp)

::: danger Experimental Feature
The lightmapping plugin is experimental. We recommend creating a backup of your .blend file when using it. Please report problems or errors you encounter in [our forum](https://forum.needle.tools) 🙏
:::

## Texture Compression

Expand Down
32 changes: 16 additions & 16 deletions documentation/examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,56 +3,56 @@
Explore some real world applications, websites and demos made with Needle Engine.

<p align="left">
<a href="./documentation/getting-started.md">Get started now</a> • <a href="./documentation/vision.md">Learn more about our vision</a> • <a href="https://fwd.needle.tools/needle-engine/docs/features-overview">Features Overview</a> • <a href="https://docs.needle.tools/samples?utm_source=needle_docs">Samples to download</a>
<a href="./getting-started/">Get started now</a> • <a href="./vision.md">Learn more about our vision</a> • <a href="https://fwd.needle.tools/needle-engine/docs/features-overview">Features Overview</a> • <a href="https://docs.needle.tools/samples?utm_source=needle_docs">Samples to download</a>
</p>


## Needle Website
<a href="https://needle.tools?utm_source=needle_docs" target="_blank">Visit Website</a> — by Needle

https://user-images.githubusercontent.com/5083203/186126996-27b45c5f-f3b9-40f7-b8c7-6ecba1d25a6e.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186126996-27b45c5f-f3b9-40f7-b8c7-6ecba1d25a6e.mp4"/>


## Castle Builder
[Play Now ⇡](https://castle.needle.tools) — by Needle
[Play Now](https://castle.needle.tools) — by Needle

https://user-images.githubusercontent.com/5083203/186145731-705cfec2-1779-4a0b-97d9-95f3edaaf2d0.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186145731-705cfec2-1779-4a0b-97d9-95f3edaaf2d0.mp4"/>




## Bike Configurator
[Bike Configurator ⇡](https://bike.needle.tools) — by Needle
[Bike Configurator](https://bike.needle.tools) — by Needle

https://user-images.githubusercontent.com/5083203/186146814-52fb05c7-a073-4efa-a226-47a9c1835413.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186146814-52fb05c7-a073-4efa-a226-47a9c1835413.mp4"/>


## Sandbox Template
[Sandbox Template ⇡](https://fwd.needle.tools/needle-engine/glitch-starter) — by Needle
[Sandbox Template](https://fwd.needle.tools/needle-engine/glitch-starter) — by Needle

https://user-images.githubusercontent.com/5083203/186149117-ca7cf22f-dc7d-4c74-86d4-d78fe53a208c.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186149117-ca7cf22f-dc7d-4c74-86d4-d78fe53a208c.mp4"/>


## Songs of Cultures
[Songs of Cultures ⇡](https://fwd.needle.tools/needle-engine/projects/songs-of-cultures) — by A.MUSE
[Songs of Cultures](https://fwd.needle.tools/needle-engine/projects/songs-of-cultures) — by A.MUSE

https://user-images.githubusercontent.com/5083203/186147814-159a33f9-f1a6-47d4-804f-5f8f5a63125d.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186147814-159a33f9-f1a6-47d4-804f-5f8f5a63125d.mp4"/>

## Pokémon Card
[Pokémon Card ⇡](https://fwd.needle.tools/needle-engine/projects/pokemon-card) — Scene from Alex Ameye • [Original Blog Post by Alex ⇡](https://alexanderameye.github.io/notes/holographic-card-shader/)
[Pokémon Card](https://fwd.needle.tools/needle-engine/projects/pokemon-card) — Scene from Alex Ameye • [Original Blog Post by Alex](https://alexanderameye.github.io/notes/holographic-card-shader/)

https://user-images.githubusercontent.com/5083203/186149736-49a697b3-4282-4b71-ab13-a6b176955c13.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186149736-49a697b3-4282-4b71-ab13-a6b176955c13.mp4"/>


## Encryption in Space
[Encryption in Space ⇡](https://fwd.needle.tools/needle-engine/projects/encryption) — by Katja Rempel & Nick Jwu
[Encryption in Space](https://fwd.needle.tools/needle-engine/projects/encryption) — by Katja Rempel & Nick Jwu

https://user-images.githubusercontent.com/5083203/186151157-0c0a7d05-ad42-44be-b553-8d4cd48cbb81.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186151157-0c0a7d05-ad42-44be-b553-8d4cd48cbb81.mp4"/>

## Physics Playground
[Physics Playground ⇡](https://bruno-simon-20k-needle.glitch.me/) — Scene from Bruno Simon
[Physics Playground](https://bruno-simon-20k-needle.glitch.me/) — Scene from Bruno Simon

https://user-images.githubusercontent.com/5083203/186149536-987ee796-3fe0-42bc-bd80-4c25aaf174aa.mp4
<video-embed src="https://user-images.githubusercontent.com/5083203/186149536-987ee796-3fe0-42bc-bd80-4c25aaf174aa.mp4"/>



Expand Down
2 changes: 1 addition & 1 deletion documentation/scripting-examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can also export an array of clips.
@[code ts twoslash](@code/component-unityevent.ts)
::: tip
EventList events are also invoked on the component level. This means you can also subscribe to the event declared above using ``myComponent.addEventListener("my-event", evt => {...})`` as well.
This is an experimental feature: please provide feedback in our [discord](https://discord.needle.tools)
This is an experimental feature. Please provide feedback in our [forum](https://forum.needle.tools)
:::


Expand Down

0 comments on commit 664f4b8

Please sign in to comment.