Skip to content

Commit 176d639

Browse files
update 3d bits tutorials
1 parent 6684d89 commit 176d639

10 files changed

Lines changed: 313 additions & 1 deletion

File tree

docs/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ const config: Config = {
8686
label: "Learn",
8787
},
8888
{ to: "/learn/code/intro", label: "Code", position: "left" },
89-
{ to: "/3d-bits", label: "3D Bits", position: "left" },
89+
{ to: "/learn/3d-bits/intro", label: "3D Bits", position: "left" },
9090

9191
{ to: "/blog", label: "Blog", position: "left" },
9292
{

docs/learn/3d-bits/_category_.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "3D Bits Shopify App",
3+
"position": 8,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}

docs/learn/3d-bits/intro.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "3D Bits: Enhance Your Shopify Store with 3D Product Visualization"
3+
sidebar_label: Intro
4+
description: Discover "3D Bits," our Shopify app designed to bring interactive 3D product configurators and visualization to your e-commerce store.
5+
tags: [shopify, 3d-bits]
6+
---
7+
8+
# 3D Bits: Interactive 3D Product Visualization for Your Shopify Store
9+
10+
## Revolutionizing 3D E-Commerce on Shopify
11+
12+
We are thrilled to announce the development of **"3D Bits,"** our dedicated Shopify app designed to bring powerful, interactive 3D product visualization and customization to your e-commerce store. This solution helps your customers visualize custom products in 3D, leading to a more engaging and informative shopping experience.
13+
14+
**Experience it Yourself:**
15+
* Check out our **[Demo Store](https://bitbybit-dev-3d-configurators.myshopify.com)**.
16+
* Use the password: `3d-bits-demo`
17+
18+
The web has evolved significantly. While traditional e-commerce relied on static images, today's complex and customizable products demand a richer presentation. "3D Bits" empowers Shopify merchants to showcase their products in interactive 3D, allowing buyers to explore variations and understand configuration options in real-time.
19+
20+
<div class="responsive-video-container">
21+
<iframe
22+
width="560"
23+
height="315"
24+
src="https://www.youtube.com/embed/UwIEYWxlGQ0?si=ZtLRjdJ8t2DXjdjl"
25+
title="3D Bits App For Shopify Demo"
26+
frameborder="0"
27+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
28+
allowfullscreen>
29+
</iframe>
30+
</div>
31+
32+
## Why We Chose Shopify
33+
34+
Shopify stands as one of the largest and most popular e-commerce platforms globally. Its key strengths make it an ideal environment for innovative solutions like "3D Bits":
35+
36+
* **Ease of Use:** Shopify is renowned for its user-friendly interface, making it simple for merchants to set up and manage their online stores.
37+
* **Rich Feature Set:** It offers a comprehensive suite of tools and features essential for e-commerce success.
38+
* **Flexibility and Customization:** The platform is highly flexible, allowing for extensive customization to meet diverse business needs.
39+
* **Vibrant Ecosystem:** A large app store and developer community foster innovation and integration.
40+
41+
We believe Shopify represents a bright future for e-commerce, and we are excited to contribute to this ecosystem with "3D Bits," helping merchants elevate their product presentation and customer engagement through immersive 3D experiences.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "Theme App Extensions",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "BITBYBIT PREVIEW Block for Shopify's '3D Bits' App"
3+
sidebar_label: BITBYBIT PREVIEW
4+
description: Learn how to use the BITBYBIT PREVIEW theme app extension block in Shopify's "3D Bits" app to embed publicly available Bitbybit project scripts into your product pages.
5+
tags: [shopify, 3d-bits]
6+
---
7+
8+
# The "BITBYBIT PREVIEW" Block for Shopify
9+
10+
The **BITBYBIT PREVIEW** is a theme app extension block provided by our "3D Bits" Shopify app. It offers a straightforward way to embed **publicly available** Bitbybit project scripts directly into your Shopify product pages. This allows you to showcase rich, unique, and interactive 3D product experiences.
11+
12+
**Key Characteristics:**
13+
* **Embeds Public Scripts:** This block is designed specifically for embedding scripts from Bitbybit projects that have been published with "Public" visibility.
14+
* **No Variant Configuration:** Unlike the [BITBYBIT RUNNER](/learn/3d-bits/theme-app-extensions/bitbybit-runner) block, experiences embedded with the PREVIEW block generally cannot be directly configured by Shopify product variants in the same dynamic way. The interaction is primarily with the pre-defined logic within the embedded Bitbybit script itself.
15+
* **Showcasing Experiences:** Ideal for presenting completed interactive demos, artistic 3D scenes, complex visualizations, or non-configurable product showcases.
16+
17+
**Live Example:**
18+
You can see an example of the BITBYBIT PREVIEW block in action on our [Demo Store Product Page](https://bitbybit-dev-3d-configurators.myshopify.com/products/towel-buckets-3dgs) (password: `3d-bits-demo`). This product directly embeds a script from this [public Bitbybit project](https://bitbybit.dev/projects/public/fA0SjbTlMGRei2zMuHuG/project-baskets-gaussian-splatting-by-author-bitbybit).
19+
20+
![A Shopify product page showing an embedded 3D scene of towel buckets, powered by the BITBYBIT PREVIEW block.](https://ik.imagekit.io/bitbybit/app/assets/start/shopify/bitbybit-embed-towel-bucket.jpeg "Demo store product using the PREVIEW block")
21+
*Demo store product that uses an embed of a Bitbybit public script.*
22+
23+
## How Does the BITBYBIT PREVIEW Block Work?
24+
25+
The process involves preparing your script on Bitbybit and then linking its preview URL within your Shopify product settings.
26+
27+
### 1. Prepare Your Script on Bitbybit
28+
* **Create/Select a Project & Script:** You'll need to have a project with at least one script created on the Bitbybit platform. (Ensure you are [signed up](https://bitbybit.dev/auth/sign-up).)
29+
* **Publish as Public:** Once your script is complete, the project containing it **must be published and set to "Public" visibility.** This makes the script accessible via a shareable URL.
30+
* Learn more about managing projects and publishing: [Bitbybit Projects Overview](/learn/getting-started/basics/projects/intro).
31+
32+
### 2. Get the Script's Preview URL
33+
You need the specific "preview" URL for your Bitbybit script. This URL runs the script in a full-screen, editor-less mode.
34+
* **How to get the Preview URL:** Please follow our guide on [Obtaining Script Preview Links](/learn/start/general/script-preview-mode).
35+
36+
### 3. Configure in Shopify ("3D Bits" App)
37+
38+
Assuming you have already installed the "3D Bits" app in your Shopify store:
39+
40+
* **Product Template & Metafield Linking:**
41+
1. You'll typically create or edit a product template in your Shopify theme customizer.
42+
2. Add the **BITBYBIT PREVIEW** block from the "3D Bits" app to this template.
43+
3. In the block's settings, you need to dynamically link the **"Model Preview URL"** setting of the block to the product metafield named **"3D Bits Model Url"**. This metafield is provided by our app.
44+
45+
![The BITBYBIT PREVIEW block settings in the Shopify theme editor, showing the "Model Preview URL" field dynamically linked to a product metafield.](https://ik.imagekit.io/bitbybit/app/assets/start/shopify/bitbybit-preview-block.jpeg "Configured BITBYBIT PREVIEW block")
46+
*After you configure the PREVIEW block, its settings should look similar to this.*
47+
48+
* **Enter the Preview URL in Product Metafields:**
49+
1. Navigate to the specific product in your Shopify admin where you want to display the 3D experience.
50+
2. Find the "Metafields" section for that product.
51+
3. Locate the **"3D Bits Model Url"** metafield.
52+
4. Copy the preview URL you obtained from Bitbybit and paste it into this metafield.
53+
54+
![The Shopify product admin page showing the "3D Bits Model Url" metafield with a Bitbybit preview URL pasted into it.](https://ik.imagekit.io/bitbybit/app/assets/start/shopify/bitbybit-model-preview-url-metafield.jpeg "Entering the preview URL in the product metafield")
55+
*Use the "3D Bits Model Url" metafield to enter the preview URL from Bitbybit.*
56+
57+
The other metafields provided by the "3D Bits" app (like those for GLB files or script content) are generally not relevant for the BITBYBIT PREVIEW block, so you can ignore them when using this specific block.
58+
59+
## Video Tutorial
60+
61+
For a step-by-step visual guide on setting up the "3D Bits" app and its blocks, including the PREVIEW block, be sure to check out this video tutorial:
62+
63+
<div class="responsive-video-container">
64+
<iframe
65+
width="560"
66+
height="315"
67+
src="https://www.youtube.com/embed/9l7run2qy0Q?si=j8uSScxl6ncJaX81"
68+
title="3D Bits App For Shopify Fast Introduction"
69+
frameborder="0"
70+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
71+
allowfullscreen>
72+
</iframe>
73+
</div>
74+
75+
By following these steps, you can effectively use the BITBYBIT PREVIEW block to enrich your Shopify product pages with engaging, interactive 3D content hosted on Bitbybit.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "BITBYBIT RUNNER Block for Shopify's '3D Bits' App"
3+
sidebar_label: BITBYBIT RUNNER
4+
description: Learn how to use the BITBYBIT RUNNER theme app extension block in Shopify's "3D Bits" app to integrate parametric 3D models and interactive scripts from Bitbybit into your product pages.
5+
tags: [shopify, 3d-bits]
6+
---
7+
8+
# The "BITBYBIT RUNNER" Block for Shopify
9+
10+
The **BITBYBIT RUNNER** is a theme app extension block provided by our "3D Bits" Shopify app. It offers powerful functionality to import scripts created in Bitbybit editors and link them with your Shopify product variants and custom line item properties. This enables dynamic, parametric 3D product configurators directly on your product pages.
11+
12+
This block is the most versatile and powerful option within the "3D Bits" app. However, mastering its usage requires a good understanding of parametric 3D model scripting and potentially some CAD concepts. If you are not familiar with these areas, we recommend:
13+
* Hiring a developer experienced with 3D web technologies.
14+
* Contacting us for a quote on our professional services to help you with the setup.
15+
16+
![An example of a customizable Shopify product page featuring a 3D table. The BITBYBIT RUNNER block powers the interactive 3D model.](https://ik.imagekit.io/bitbybit/app/assets/start/shopify/bitbybit-dev-3d-bits-app-configurable-table-product.jpeg "Customizable product page using the RUNNER block")
17+
*Example of a customizable product page with a 3D table, where the RUNNER block is being used.*
18+
19+
The BITBYBIT RUNNER block allows Shopify merchants to present parametric 3D models and interactive experiences that have been scripted using the editors on [bitbybit.dev](https://bitbybit.dev). It seamlessly integrates a 3D canvas into your product page. Our app intelligently listens for changes in various input values on the page (like dropdowns for variants, or custom input fields) and sends these values to your "smart" Bitbybit script. Your script can then use these inputs to adapt and update the 3D model in real-time.
20+
21+
**Is the RUNNER Block Right for You?**
22+
23+
* **If your products are simple, static, and not meant to be customized parametrically:**
24+
The RUNNER block might be more than you need. In such cases, we encourage you to explore our other "3D Bits" app blocks:
25+
* [**BITBYBIT VIEWER**](/learn/3d-bits/theme-app-extensions/bitbybit-viewer): Ideal for displaying one or multiple static 3D models on your product page without needing to use the Bitbybit editors.
26+
* [**BITBYBIT PREVIEW**](/learn/3d-bits/theme-app-extensions/bitbybit-preview): A great option if you want to embed a publicly available script from the Bitbybit platform directly into your product page.
27+
28+
## How Does the BITBYBIT RUNNER Block Work?
29+
30+
While we offer several [tutorials to guide you through the specifics](/learn/3d-bits/tutorials/intro), the core principle is straightforward:
31+
32+
1. **Create Your Script:** Design and code your parametric 3D model or interactive experience using one of the editors (Rete, Blockly, or TypeScript) on the [bitbybit.dev](https://bitbybit.dev) platform.
33+
2. **Export Your Script:** Use the "Export to Runner" feature within the Bitbybit editor to generate JavaScript code from your visual or TypeScript program.
34+
3. **Integrate in Shopify:** Copy this exported JavaScript code and paste it into the designated field within the BITBYBIT RUNNER block settings in your Shopify theme editor.
35+
4. **Link Inputs (Optional but Powerful):** Configure the block to link Shopify product variants or custom line item properties to specific input parameters defined in your Bitbybit script.
36+
37+
This process allows merchants to first define their adaptable 3D designs on Bitbybit, choosing from low-code visual programming editors or our TypeScript IDE. Then, they can bring this dynamic logic into their Shopify store via the "3D Bits" app, creating truly interactive product customization experiences for their customers.
38+
39+
For more detailed instructions and examples, please follow the tutorials available on our [Shopify Start Pages](/learn/3d-bits/tutorials/intro).

0 commit comments

Comments
 (0)