Skip to content

Commit

Permalink
Merge branch 'main' into animation-prevents-editing
Browse files Browse the repository at this point in the history
  • Loading branch information
Algorush authored Feb 7, 2024
2 parents 0b20b1f + 52c84f2 commit d16b602
Show file tree
Hide file tree
Showing 14 changed files with 234 additions and 307 deletions.
121 changes: 0 additions & 121 deletions CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ We welcome community contributions to 3DStreet.
- Use command line to create new tag for new version `git tag 0.4.4` and `git push --tags`
- Create a new release here: https://github.com/3DStreet/3dstreet/releases/new. Choose the tag you just created. (If needed for the title simply use the new version such as "0.4.4")
- Click to automatically "generate release notes." Consider summarizing a few key changes to put at the top.
- Use those summaries to update CHANGELOG.md in this repo with "Major improvement" changes summary and link to the new release for detailed changes
- Update https://www.3dstreet.org/docs/development/releases/ with summary of major improvements and linking back to the new release on github.
- Then to run npm publish after all github version stuff works

Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@

### Online Tool

|[Start 3DStreet](https://github.3dstreet.org/)|
|[Start 3DStreet](https://3dstreet.app/)|
|---|

_(or visit https://github.3dstreet.org)_
_(or visit https://3dstreet.app)_

<img height="500" src="https://raw.githubusercontent.com/kfarr/streetmix3d/master/ui_assets/streetmix3d.jpg" />

### [Quick Start - How to make your own 3DStreet scene from Streetmix. See documentation here.](https://www.3dstreet.org/docs/category/tutorial-use-streetmix-to-create-a-3dstreet-scene)

<img src="https://raw.githubusercontent.com/kfarr/streetmix3d/master/ui_assets/streetmix3d.jpg" />
## The rest of this README is for developers. [User-facing docs are here.](https://www.3dstreet.org/docs/)

### Quick Start - How to make your own 3D street:
* First, use <a href="https://streetmix.net">Streetmix.net</a> to create a street design. (Streetmix is a tool that lets you design, remix, and share your neighborhood street. <a href="https://github.com/streetmix/streetmix/blob/master/README.md#about">More information about Streetmix here</a>.)
* Then, save a Streetmix street after making an account to generate a unique URL for your street looking something like this: `https://streetmix.net/kfarr/3/my-awesome-street-name`
* Load https://github.3dstreet.org/, paste in your street URL, and press enter or the refresh button.
* See your Streetmix street in 3D! See instant changes to your work: Switch back to a Streetmix.net tab, make changes to your street, then reload the 3DStreet page to see the edits applied.
* For more information, please see our [3DStreet and Streetmix Tutorial](/tutorials/3DStreet-streetmix-tutorial.md).
This repo is the 3DStreet Core Viewer. It provides parsing of JSON in Streetmix format into a 3DStreet scene. It also provides all of the core components needed for viewers. It is also a core dependency of the [3DStreet Editor hosted in a separate repository](https://github.com/3DStreet/3dstreet-editor).

### Project Hosting Path
This repo's main branch is hosted via github pages at `github.3dstreet.org`. The 3DStreet Editor uses this path to fetch 3DStreet dependencies. A-Frame developers leveraging 3DStreet Core will also use this path.

## A-Frame component
3DStreet is built upon a custom A-Frame `street` component which is also available for you to customize for your own custom A-Frame street scenes. The `street` component takes a string of JSON and renders one or more "segments" (also known as lanes or slices) of a street and optionally buildings and ground to the left and right.
Expand All @@ -34,11 +34,11 @@ _(or visit https://github.3dstreet.org)_
<html>
<head>
<title>Street Component!</title>
<script src="https://aframe.io/releases/1.3.0/aframe.min.js"></script>
<script src="https://unpkg.com/3dstreet@0.3.2/dist/aframe-street-component.js"></script>
<script src="https://aframe.io/releases/1.5.0/aframe.min.js"></script>
<script src="https://unpkg.com/3dstreet@0.4.5/dist/aframe-street-component.js"></script>
</head>
<body>
<a-scene gltf-model="dracoDecoderPath: https://www.gstatic.com/draco/v1/decoders/;">
<a-scene>
<a-entity id="mySimpleStreet" street streetmix-loader="streetmixStreetURL: https://streetmix.net/kfarr/3/" ></a-entity>
</a-scene>
</body>
Expand Down
4 changes: 2 additions & 2 deletions dist/aframe-street-component.js

Large diffs are not rendered by default.

28 changes: 15 additions & 13 deletions mapbox.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<!-- aframe -->
<script src="https://aframe.io/releases/1.4.2/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.5.0/aframe.min.js"></script>

<!-- 3dstreet -->
<script src="./dist/aframe-street-component.js"></script>
Expand All @@ -13,9 +13,6 @@
<!-- save / load -->
<script src="./src/json-utils.js"></script>

<!-- ocean -->
<script src="./src/components/ocean-plane.js"></script>

<title>3DStreet</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon" type="image/x-icon" href="ui_assets/favicon.ico">
Expand Down Expand Up @@ -45,6 +42,10 @@
vr-mode-ui-if-headset
renderer="colorManagement: true; physicallyCorrectLights: true;"
inspector="url: //3dstreet.app/dist/3dstreet-editor.js"
notify
metadata
scene-title
reflection
>
<a-assets>
<!-- uncomment the line below to load assets from local github submodule -->
Expand All @@ -55,14 +56,6 @@
<street-assets categories="loud-bicycle sidewalk-props people vehicles vehicles-rigged buildings segment-textures segment-colors lane-separator stencils vehicles-transit dividers sky grounds"></street-assets>
</a-assets>

<a-entity id="cameraRig" data-layer-name="Viewer" cursor-teleport="cameraRig: #cameraRig; cameraHead: #camera;" look-controls="reverseMouseDrag: true" wasd-controls="enabled: true">
<a-entity id="camera" camera="near: 1; far: 1000" position="0 1.6 0"></a-entity>
<a-entity id="leftHand" hand-controls="hand: left; handModelStyle: lowPoly; color: #ffccff" teleport-controls="cameraRig: #cameraRig; button: trigger"></a-entity>
<a-entity id="rightHand" hand-controls="hand: right; handModelStyle: lowPoly; color: #ffccff" teleport-controls="cameraRig: #cameraRig; button: trigger"></a-entity>
</a-entity>

<a-entity id="environment" data-layer-name="Environment" street-environment="preset: day;"></a-entity>

<a-entity id="street-container" data-layer-name="3D Street Layers" data-layer-show-children>
<a-entity
data-layer-name="16th Street West of SVN"
Expand Down Expand Up @@ -105,6 +98,15 @@
streetmix-loader="streetmixStreetURL: https://streetmix.net/scott/31/south-van-ness-idea-short-term; showBuildings: false;"
></a-entity>

<a-entity id="environment" data-layer-name="Environment" street-environment="preset: day;"></a-entity>

<a-entity id="cameraRig" position="0 10 30" data-layer-name="Viewer" cursor-teleport="cameraRig: #cameraRig; cameraHead: #camera;" look-controls="reverseMouseDrag: true" wasd-controls="enabled: true">
<a-entity id="camera" camera="far: 1000" position="0 1.6 0" ></a-entity>
<a-entity id="leftHand" hand-controls="hand: left;" blink-controls="cameraRig: #cameraRig; teleportOrigin: #camera; rotateOnTeleport:false;"></a-entity>
<a-entity id="rightHand" hand-controls="hand: right" blink-controls="cameraRig: #cameraRig; teleportOrigin: #camera; rotateOnTeleport:false;"></a-entity>
<a-entity id="screenshot" class="no-pause" screentock visible="false"></a-entity>
</a-entity>

</a-entity>

<a-entity id="reference-layers" data-layer-name="Reference Layers" data-layer-show-children>
Expand All @@ -113,7 +115,7 @@
geometry="primitive: plane; width: 512; height: 512;"
material="color: #ffffff; shader: flat; side: both; transparent: true;"
mapbox="center: -122.417490, 37.765190; zoom: 18;
accessToken: pk.eyJ1IjoibWF0dHJlIiwiYSI6IjRpa3ItcWcifQ.s0AGgKi0ai23K5OJvkEFnA;
accessToken: pk.eyJ1Ijoia2llcmFuZmFyciIsImEiOiJjazB0NWh2YncwOW9rM25sd2p0YTlxemk2In0.mLl4sNGDFbz_QXk0GIK02Q;
style: mapbox://styles/mapbox/satellite-streets-v11;
pxToWorldRatio: 4;"
position="-7 -1 -2"
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "3dstreet",
"version": "0.4.4",
"version": "0.4.6",
"description": "Web-based 3D visualization of streets using A-Frame and WebXR",
"main": "dist/aframe-street-component.js",
"scripts": {
Expand Down
Loading

0 comments on commit d16b602

Please sign in to comment.