Skip to content

Commit eaa3eee

Browse files
authored
Add instructions for non-studio setup (#36)
* Draft: Add instructions for non-studio setup * Draft: Add instructions for non-studio setup * Add instructions for non-studio setup
1 parent c8ff94a commit eaa3eee

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
id: non-studio-projects
3+
sidebar_position: 100
4+
---
5+
6+
# Non-Studio Projects
7+
8+
The primary way of using the 8th Wall desktop app is with Studio projects, which use 8th Wall's scene graph format (`src/.expanse.json`) and ECS framework.
9+
10+
Projects that aren't considered Studio projects (projects built with A-Frame, Three.js, etc) can still utilize the 8th Wall desktop app for specific features such as asset management, image targets, and the simulator, by opening in a separate Non-Studio mode. Non-Studio mode does not include a 3D scene editor.
11+
12+
## Minimum Requirements
13+
14+
1. The folder contains a `package.json` file.
15+
2. `npm run serve` starts a local build server.
16+
- For preview to work, the `--port` argument, or the `PORT` environment variable, should be honored, e.g. `PORT=8888 npm run serve` should host the content on http://localhost:8888.
17+
- If the command starts with `node `, the command will be invoked through the desktop app's internal node executable. Otherwise, node/npm are required.
18+
19+
## AR Simulator + Device Connect
20+
21+
1. dev8.js is loaded for development builds.
22+
23+
You can add dev8.js to your project's `index.html` `<head>` with:
24+
25+
```html
26+
<script src="https://cdn.jsdelivr.net/npm/@8thwall/ecs@3/dev8/dev8.js"></script>
27+
```
28+
29+
:::warning
30+
Note that this script should not be included in production builds. [This sample configuration](https://github.com/8thwall/studio-world-effects-example/blob/main/config/webpack.config.js#L93-L98) shows one way to achieve this, though it might vary depending on your configuration.
31+
:::
32+
33+
34+
## Image Targets
35+
36+
1. Image Targets are stored in the `image-targets/` folder (not inside `src/`), with no subfolders.
37+
38+
## File Browser (optional)
39+
40+
1. Source code is in the `src` folder.
41+
2. Non-text assets (e.g. images, models) are contained in in `src/assets/`.
42+
43+
## Publishing
44+
45+
1. `npm run build` generates a production build in the `dist` folder.
46+
47+
## Questions?
48+
49+
Please open a discussion or issue [on Github](https://github.com/8thwall/8thwall).
50+

0 commit comments

Comments
 (0)