Merge pull request #8 from kfarr/0.1.1

0.1.1
kfarr · Apr 1, 2017 · 21d58bd · 21d58bd
2 parents 21f61ca + bda35ac
commit 21d58bd
Show file tree

Hide file tree

Showing 422 changed files with 105,574 additions and 57,480 deletions.
diff --git a/.firebaserc b/.firebaserc
@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "test-b0c62"
+  }
+}
diff --git a/404.html b/404.html
@@ -0,0 +1,81 @@
+
+<!doctype html>
+<html>
+  <head>
+    <title>Page Not Found</title>
+    <style>
+      body {
+        margin: 0 auto;
+        padding: 1em;
+        font-family: Helvetica, Arial, "Lucida Grande", sans-serif;
+        font-size: 1.1em;
+        color: #333;
+      }
+      @media screen and (min-width: 40em) {
+        body {
+          width: 40em;
+        }
+      }
+      h1, h2, h3 {
+        font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
+        font-weight: 300;
+      }
+      h1 {
+        margin: 1em 0;
+        padding: 0 0 0.25em 0;
+        border-bottom: 1px dotted #ccc;
+        text-align: center;
+        font-size: 3em;
+        line-height: 1.1em;
+      }
+      h2 {
+        margin: 1em 0 0.45em 0;
+        padding: 0;
+        font-size: 1.8em;
+      }
+      p {
+        margin: 0 0 0.5em 0;
+        line-height: 1.8em;
+      }
+      ol {
+
+      }
+      ol li {
+        margin: 0 0 0.5em 0;
+        font-size: 0.9em;
+        line-height: 1.8em;
+      }
+      a {
+        color: #50B1FF;
+        text-decoration: none;
+      }
+      a:hover {
+        text-decoration: underline;
+      }
+      code {
+        display: inline-block;
+        padding: 0.1em;
+        background-color: #F8F8F8;
+        border: 1px solid #DDD;
+        border-radius: 3px;
+        font-family: Consolas,"Liberation Mono",Courier,monospace;
+        font-size: 0.9em;
+        line-height: 1;
+      }
+      .logo {
+        display: block;
+        margin: 3em 0;
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Page Not Found</h1>
+    <p>This specified file was not found on this website. Please check the URL for mistakes and try again.</p>
+    <h2>Why am I seeing this?</h2>
+    <p>This page was generated by the Firebase Command-Line Interface. To modify it, edit the <code>404.html</code> file in your project's configured public directory.</p>
+    <a class="logo" href="//firebase.google.com">
+      <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJQAAAAaCAYAAABRhnV8AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA3NpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNS1jMDE0IDc5LjE1MTQ4MSwgMjAxMy8wMy8xMy0xMjowOToxNSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDoyNWM4MWUxOS0zYWJmLTQyYWYtOTVhMi01MDBiZWU5NzAyMTgiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MkNCQkJBMDlCNkRGMTFFM0JDMTdBQTgyNEFEQURCQTQiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MkNCQkJBMDhCNkRGMTFFM0JDMTdBQTgyNEFEQURCQTQiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIChNYWNpbnRvc2gpIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6ZWFkZWM0M2YtMmFjMy00NTEyLTljNzQtYjVmMDJjMWNhNTkxIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjI1YzgxZTE5LTNhYmYtNDJhZi05NWEyLTUwMGJlZTk3MDIxOCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PihlPGsAAAqkSURBVHja7FoJVFTnFb4zA4LsIDuIIqi4xRUBQRHRomKiFkmNa2JIXY9NPSeJ6an1WGOT1JimbUzribEnaqtGiUuk4r6iIsquIFtQFEQQZN9kpvfemfd4MwxbQs/JyXl3zjvzb+9f7v/99373n1EASmxsrJm7u/t2pVK5GLMOIIss3ZcmtVr9VXFx8YaoqKgmEyxQuLq6foKAWocPmJiYyCqSpdui0WjMioqK1uB3HWbfI/QoVSrVYmdnZ3jx4gW0tLTIWpKlR0LYKSkpicHk+wQolUKhsEeEyZqR5YdaKSAMEZZMpIWyyPJjRUkcSlaDLL0kii4t1OYPd3T49qLo+bBn30FO/2b1m+Du6tKj0T/7x24oefIUlr22AEb4DZG342cgXYZ0jY1N3TN1CmXPzaPuHaVSKe/Ezw1QXXGo1W8uA1tbG70ya0tL2LhhHaetLCygovI5p+3tbKH0aTlYWPQFaytLaG1Vw6PHxdCCUWR/DzcwMzNr1391TS1aq1Jw7OcADvZ2EsIH2G8l11tZWmB9PySAbe/V1TdAWfkzsOhrDk6Ojnp15c8qeE79HOz5keUnBCh7OxuwtbFpx+4/+vRzTq9asRT+uWcfpyPCQ+H0+cuwdGEUg2PvgViofK4FW58+fSB6XiSMHDZU7CfjbjbsOxiLwGvlfHDABIicOR0aGhrhi91fw7OKSrGtq7MTvLHkVbCxtobbKelwLC6eAUvignXLcExbG2s4cjwOUjPuie+NfWkELJg3B62iccr4/paPxLQlHoR5kREwcrgfJNy8BSdPX9Br++HmjWL68NHv4H5eAbyzfjUelD5ctvfAYQibEoyHx53zxvqYEzFNTAcHTuR3ynGdG9b+Wiw/GX8WEhLv8HhFeCC/2L1Xr481McvEMYyNExwwHmaEhYrzIvlg+1/By9MdaUa0ONesnHyj/d5OSYPYE6fajdMrgDp8LA5MJZeeg7wHwKSJ49vYmGSfzl9OEPvce+AIgqkKvAd4gRVaq4y7WXDo2+/Ac52r2P5Oajq4uTqDCoNOsmQJibfBw92NQUDi5NgPN9mClfrkaRmcOnsJFsydDXGnz3NMMWVSANcR8AhoZy9eZTCRdRzuN5THTEm/C64uzjA5aGKHa/z8k238nZqeCQeOHIcRCHqaU9QrsxkgojWtrtZZ1RpIpn6dHSE3v4Dbk6hUKlChGxd0GjYlBGbOCIeLVxJ0+WBoamqCKwk3RT3RO2XlFdyP7yBvrG9mMIn12N8oBPhKPLiC1NfX892hINK5VlVV42E7hbo+jgd7AddnZmWzTghAVbgG0tXKFcv4MnsXGoOZ06fCAK/+Yr9Xb9ziA5yemQWeuB+9wqEEyc3/Xi9vgRvckTj2s4df/XIuKqicwUTgINJOQpaIAERWSZDhSMhXvrGE0/sPxUJSchoCIBPGjBoO7769BszRRdICc9AS7PrXfih8+IjdZyNuCinDq78HzJszExqQ72k0aki8k6J10zHLwQ1BNH7MKLZ0yWmZnQJKAMpAL090pfViOY0t1EklL7+QN3nUCD8+BCMkVlcqBB56hM031heJz0AvSMu8x4Cizad8fuFDiUdQd/iu4VxVKiUeujmw9c+fMfAJPDm5BTApwB8el5TAbdTxtNAQBo/Qd2Njo9g/0Yh6pBME4B1/3wXh2FZq6X60hZo1I0wPRI7ISTp6hxbijhYn634u58ndffyXndpT1dCgnfCzSj13VFtbq0uPZEAR96mtq2OTm1dQyO7QxtpK3CAzdJ1DfAcxyPYf+haOnoznRQ/FMiGQ2HfwCC6sbW1Py8o7Xec1PJEkd7NzGCjatho4/t+z+JwR223b9C5/X7mRCJER4eDrPRD+c/gY90/WVOB+7cfSGOhaPx8aEgR79h+C6VMns3WYEzGdAUX11CQzKwd+98eP23jtiiXgqeeK2vojfSnQbXgP6M/8k8pup2bArF+EIzVw5IMttbqGc751JxUmjB0NzrgeAnbmvSwYN+al3gMUbTSRbUFowlJzK33dwd6Wf8IxMVFxnlwlkW3BN5J39HBzgeKSJ1xUW1snjk8gEiI/4mH3c/PRDHsiH/DnDTt36SrXq9VqiFm+CC5fuwE3k5LZ3Z3ATSeT3zYPe5EzOTs5drlOU1MTNu8u2DZqbqT4M5Shy3uOB+TR4xKczzMoRzdVWlrGriEpORUP3jTd1mo6HMuwXMgTdyMgn7lwha2D3xBfsZ4+hi6PDqF0Dwz7Iwv+/YMieHnWDEhDCkBzTEbvoFQqUM/1CJJsPasqzLmpuZkt5bjRI1G/16Fv374I8CQYO3pUty42uyWkXMF0S823MSHroXUd/XXgU8P8l2fCiqULIWxyEARMGItE1F9iGZLYItFJunjlOpd5eXpwlEYyA08sub+hg330xjl97iIr+Q/v/RZCgwO5rAbBKUR0w3BDaMyFC+bySV2+KLrTNU6eFAivRc+HW2ghKeJscyMtDCLh4UACN4PGps0hIPoN8cFNyOLN+KGixs0kl0x8j3hhs0Ff5Jak8+hsD8jNnYw/x+u2wmg8CQk2zZEOuVLHxwg0xiQfPQJF1BRQmZqawmCfgfAUXSAdol6zUFqzq+m0XlSMWht10RXBsCGDkQTmwrbtfwNLJITV1TW8KGk0U4HK+XTnl20oxwVPCQ6A68hLHhQ9hm8wkiKAkesTpKDwAZP/C/iQ9atCBZIQeXR1ceJggCK90+cvMbci5Tc3tyCHGN/hGhrQHZMiySL9+5ujsH7VCra8J06dZbcnyDvrVzFn2rD2LQwmXEQinp2Th7xKyzV3fvm12H7l64vRNbmJVlzQVfu8hvkgWZIJ48boldNDLu/3H2xv16/US0jnGoqgnI0uOSUtgy1eRPhU8d8k5L42/2kHkvMakUoI45y7dA1CENhBkqDrOZL8DHR7Hu6unV+Vk0FJTExs9PX17eA2+yv+jsGTTlFaR/ULo16Bg7EnOP22joCztUJCHXfmArsD4ja02ZHIDQai4oh3UNRG7oRM8cNHxcxBiGB7oaKIeFOfBCRyB4H+49G3p4C5uRmsfet1juQSkGuUoiuk6IUIZ0iQP7u5bCSg8ecuwBN0R3QfFjhhHHOs1lbjp9rBwQEqKrQWkUw8zZusAKXpkQqV29nZQQ2CWPrvDCojUNLVCJ1sQYR2Qj8NOh4pzVsjaSZSTO2oHyLHdDCFeVF/1EYqhuMbzpU8CZFumg/xX5q3AFI6tDQOldE4huPTu8I82R1bave+TkdJ2gUoeXkQEBBgLgLKx8fH+P2TvdZ9VFVViZbHWD0tTlhwZWWl5DpBwYuhDaI0cS9aJJlzGxsbPtk0caqn0yOtp0VbWVlxOft2IuPYjtKkCHNzc36oD5obKURQArUj5VKd8C71K/8I/v+R/Px8BlSX1wZScHRVb6wtbSCh2hiypSEwgaEdp1C3D5PrJeE8vWPsPWmoLstP9KZcFlm6I/KvsrL0uoVC46ShP5qbKRTyX6Nk6bnookPiFxqlLsrYR5GEMdItiyxdgYmwg9x2t2ChWrds2bJx06ZNGoycXsXIylZWkyw9AFQzBlz7t27dupmwpNDdRdGliZnuW/Z7svQIU/jQZRiF2y8E8Ch0BF0lycsiS3fAREJ/ZCO+pPmfAAMATcOcUAm+qPcAAAAASUVORK5CYII=" />
+    </a>
+  </body>
+</html>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.1.1 - 2017-04-01
+### Added
+* added new objects (valencia street pack)
+* made a few youtube videos of city builder and UI: https://www.youtube.com/watch?v=ni_AF6RYtZo
+* added guide in readme re how to contribute new objects to repo
+* "first ui" blog post about city builder aframe select bar: https://medium.com/p/38b0c86ed7b7/
+* added 2nd controller element with action menu commands
+* added teleport
+* added save to firebase
+* aframe.city domain registration and firebase hosting
+* add new game title, city name and favicon, yay 🏗️ aframe.city!
+* new camera view before entering VR mode - rotation is a bit wonky
+* check if city name is invalid before saving - note this is client side only, no server validation. it is possible to overwrite all firebase cities with a malformed city name :/
+* add randopeeps npm module for fun random city names
+* city saved as URL camel case hash shortname that can be easily shared
+* open a city by simply visiting the city's hash url (aframe.city/#CityName)
+* add city name hash to page title when saved / opened / saveAs'ed
+* tie firebase save to VR action menu ui
+* added saveas menu option
+* added new city menu option - no warning, use with care!
+
+### Changed
+* removed select-bar component from this project and added reference to new repo: https://github.com/kfarr/aframe-select-bar-component
+* moved "trigger" event to select bar component
+* convert from bmfont to new aframe text component
+
 ## 0.1.0 - 2017-01-29
 ### Added
 - Added many more objects! vehicles, aliens, buildings, and pre-fab scenes!

diff --git a/README.md b/README.md
@@ -22,14 +22,56 @@ A-Frame project demonstrating touch controls for building a VR city scene.
 ## Changelog
 - See history of newly added features here https://github.com/kfarr/aframe-city-builder/blob/master/CHANGELOG.md
 
-## Credits
-* most models made by Mike Judge, see more here: https://github.com/mikelovesrobots/mmmm
-* table http://tf3dm.com/3d-model/table-65702.html
-* tree and simple base plates created by kfarr using magicavoxel (https://ephtracy.github.io/)
-* city builder text based on https://github.com/ngokevin/kframe/blob/master/components/text/examples/vaporwave/index.html
+## How do I add new objects to City Builder?
+City Builder is only as cool as the objects you can place! So let's add more! (Some day I'd love to have a sketchfab-like fancy cloud interface for uploading objects, an in-app voxel editor and more, but for now you'll have to do a bunch of manual work.)
+
+### Step-By-Step Guide
+(1) Make the object - I suggest using MagicaVoxel: https://ephtracy.github.io/
+
+(2) Come up with a filename - Each object has unique filename according to this suggested naming convention: "creator_group_object". For example "kfarr_bases_valencia" or "mmmm_obj_candle".
+
+(3) Export to OBJ and take preview image
+For each object, there are multiple files using the same filename but with different extensions to represent their function in the application:
+* .jpg - A preview image used to represent the object in a menu interface, stored here: /assets/preview/. Should be 1:1 aspect ratio, suggested 256 x 256 dimensions. (Required)
+* .obj, .mtl, .png - Object file format used when placing into A-Frame scene, stored as three files per model here: /assets/obj/ (Required)
+* .vox - The object's raw source file that can be edited again in the future, stored here: /assets/vox/ (Optional)
+
+(4) Add to JSON File - To enable placement of the object within the City Builder app, the object needs to be included in a "creator_group" JSON file. Here's an example: /assets/mmmm_veh.json
 
-## wishlist
-NOT IN THIS RELEASE
+To make it easier to add a large number of objects at once, there is a utility script to create a new "creator_group" JSON file here: /utils/json_builder.js
+
+(5) Load JSON file from City Builder - You must add the newly created JSON "creator_group" file to the list of included model definitions upon load of City Builder app. Add your filename to this list:
+https://github.com/kfarr/aframe-city-builder/blob/master/lib/builder-controls.js#L57
+
+(5) Test it out! Take a screenshot while you're testing! Submit a pull request and include a note and your fancy screenshot!
+
+## Need inspiration? What are some other objects to make?
+* more cool vehicles
+* flying things
+* more "bases" like intersection, left turn, right turn, green park only, pedestrian and bike path only
+* more advanced light poles, signals, signs
+* people
+* trains
+
+## How can I contribute to City Builder?
+Fork this repo, start making changes, and submit a pull request! Also feel free to file an issue or reach out directly kieran.farr@gmail.com with your idea and I can try to help make your idea work.
+
+## Need inspiration? Here is a partial wishlist for City Builder features:
+NOT IN THIS RELEASE - LATER THINGS TO DO:
+- remove old UI2D, add same icons as action menu bar! old dialog pops open
+- show a list of cities
+- show a city at the start by default - which one? random? list?
+- show HUD message for save success with city name - in VR and on browser desktop
+- updating hash should trigger loading new city: https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onhashchange
+- error handling when city in hash cannot be loaded from firebase
+- remove load and save functions from index, can add to action-controls or new component
+- try inverted teleport from forked repo
+- add aframe.city to chrome/daydream vr whitelist
+- erase tool
+- inspect (magnifying glass)
+- auto save with visual indicator (custom firebase that works)
+- show stats in addition to city name - size of city (objects, area), population (number of chr objects)
+- load directly from voxel https://gist.github.com/JoshGalvin/398ad2339ad7ae93e72489684d599466 https://github.com/daishihmr/vox.js
 - enable second controller
 - new bases to fit scene (http://streetmix.net/kfarr/3/a-frame-city-builder-street-only)
 - ability for select bar component to delay loading / init
@@ -66,16 +108,13 @@ NOT IN THIS RELEASE
 - try isometric view on mobile / non-vr devices (examples https://github.com/aframevr/aframe/issues/84 and http://wafi.iit.cnr.it/webvis/lab/preview.php?gist_id=07b5887a1d57b40b6065)
 - add non-flat lowpoly terrain like this example https://playcanvas.com/
 
-
-
-## future cool objects to add
-* more cool vehicles
-* flying things
-* more "bases" like intersection, left turn, right turn, green park only, pedestrian and bike path only
-* more advanced light poles, signals, signs
-* people
-* trains
+## Credits
+* most models made by Mike Judge, see more here: https://github.com/mikelovesrobots/mmmm
+* table http://tf3dm.com/3d-model/table-65702.html
+* tree and simple base plates created by kfarr using magicavoxel (https://ephtracy.github.io/)
+* city builder text based on https://github.com/ngokevin/kframe/blob/master/components/text/examples/vaporwave/index.html
+* vox/kfarr_veh_tram_avenio.vox inspired by https://sketchfab.com/models/7e3d9f90af9447dabcb813a4af43ae76
 
 ## License
-* The A-Frame City Builder codebase is MIT License Copyright (c) 2016 Kieran Farr
+* The A-Frame City Builder codebase is MIT License Copyright (c) 2017 Kieran Farr
 * Most nice looking objects are made by Mike Judge from his <a href="https://github.com/mikelovesrobots/mmmm">"Mini Mike's Metro Minis" project</a> under the <a href="https://github.com/mikelovesrobots/mmmm/blob/master/LICENSE">Creative Commons License.</a>