contrib/model_viewer: update README file
[nit.git] / contrib / model_viewer / README.md
1 Sample portable 3D app implemented with the gamnit depth framework
2
3 This application uses the _depth_ framework to load and display 3D models.
4 It also applies the _flat_ framework to display the static UI elements (like the "Next model" label).
5
6 The pretty earth model (`GlobeModel`) is implemented by a material with a custom graphical program.
7 It renders the earth with an displaced surface, a cloud layer, city lights and Phong lighting effects on the water.
8
9 # Variations
10
11 * The standard application is compiled to a desktop executable at `bin/model_viewer` and an Android package at `bin/model_viewer.apk`.
12 * The virtual reality variant `bin/model_viewer_vr.apk` targets Android and uses Google Cardboard for head tracking.
13
14 # Art
15
16 * 3D models `Tree_01` and `Oak_Fall_01` were created by Kenney.nl and published under CC0.
17 * 3D model `Quandtum_BA-2_v1_1` was created by Quandtum and published under CC0.
18 * Some textures on the `Quandtum_BA-2_v1_1` model have been created with images from goodtextures.com.
19   These images can be used in free softwares, some restrictions still applies for modifications and other uses.
20 * Globe textures credit: NASA, Visible Earth