vizicities/README.md

# ViziCities (0.3)

A framework for 3D geospatial visualisation in the browser

![]()


### Important links

* Examples
* Getting started
* Attribution
* License


## Quick install

Already know what you're doing? Here's the quickest way to install ViziCities...


## Examples

* Basic example (2D basemap and 3D buildings)
* Buildings coloured by height
* GeoJSON example (points, linestrings and polygons)
* NYC MTA routes
* All the things (will test even the best computers)


## Main changes since 0.2

* Re-written from the ground up
* Complete overhaul of visual styling
* Massive performance improvements across the board
* Vastly simplified setup and API
* Better management and cleanup of memory
* Sophisticated quadtree-based grid system
* Physically-based lighting and materials (when enabled)
* Realistic day/night skybox (when enabled)
* Shadows based on position of sun in sky (when enabled)
* Built-in support for image-based tile endpoints
* Built-in support for GeoJSON and TopoJSON tile endpoints
* Built-in support for non-tiled GeoJSON and TopoJSON files
* Click events on individual features (when enabled)
* Internal caching of tile-based endpoints
* Easier to extend and add new functionality
* Easier to access and use general three.js features within ViziCities
* Separation of three.js from the core ViziCities codebase


## Getting started


## Using ViziCities? Please attribute it

While we love giving you free and open access to the code for ViziCities, we also appreciate getting some recognition for all the hard work that's gone into it. A small attribution is built into ViziCities and, while possible to remove, we'd really appreciate it if you left it in.

If you absolutely have to remove the attribution then please get in touch and we can work something out.


## Getting involved

* Wishlist / suggested tasks
* How to contribute


## Contact us

Want to share an interesting use of ViziCities, or perhaps just have a question about it? You can communicate with the ViziCities team via email (hello@vizicities.com) and Twitter (@ViziCities).


## License

ViziCities is copyright [UrbanSim Inc.](http://www.urbansim.com/) and uses the fair and simple BSD-3 license. Want to see it in full? No problem, [you can read it here](https://github.com/UDST/vizicities/blob/master/LICENSE).