/**
 * Gallery3d 1.4.1 31/08/2020
 * Copyright @ 2010-2019 Jérôme Jouvie
 * 
 * Contact: support@bonzaiengine.com
 * Homepage: http://www.bonzaiengine.com/?gallery3d
 * License: See LICENSE-Gallery3d.txt
 */
 
======
README
======

This build is an early development build.
The Gallery3D will contains some on-screen debug information.

A user-application is in development and is not available at
this time. Text file editing is currently required to create and setup
a Gallery 3D applet with your models.

Before starting using this tool, make sure you have install java 6 or
above. If not, you can get the latest version from  www.java.com


1) Adding models

For each model to add, create a new folder inside 'datas-new\models'
and copy the model and all of its textures.

All files should not contains space, accent, or any special characters
(no # ; : \ / etc ...). Using lower case is recommended.

Ex:
 datas-new\models\model1\character.3ds
 datas-new\models\model1\skin.png
 datas-new\models\model1\head.tga

 datas-new\models\model2\landscape.obj
 datas-new\models\model2\landscape.bmp

Note: After building the gallery on the step 3),
all files from 'datas-new' will be moved to 'datas-orig'.
If you need to modify some of the files, move them
back to 'datas-new' and redo step 3) to rebuild them.

2) Using models

Open 'gallery.xml' with a text editor.
Add all the models to show in the gallery as follow:

Ex: To use the models from the previous example,
fill the object tags as follow:

	<object>
		<model>model1/character.3ds</model>
	</object>
	<object>
		<model>model2/landscape.obj</model>
	</object>


3) Edit script settings

Open script/deploy-settings.bat with a text editor,
and edit the properties as follow.

GALLERY_NAME is the name of the gallery you are creating.
Choose a unique name all in lower case without accent
(ex: your own name).

GALLERY_OWNER_NAME is the name of the owner of the assets. It could
be your name or pseudo. The name should be surrounded with "

SERVER_DIR is the online address where of the gallery will be hosted
and where your visitors would see it.

JAVA_EXE is the location of the java executable. Usually you can
just leave the value 'java'. If you have any trouble, please locate
the java.exe file on you computer and use the full path to this file.

Ex:
 set JAVA_EXE=java
 set GALLERY_NAME=jerome-jouvie
 set GALLERY_OWNER_NAME="J�r�me JOUVIE"
 set SERVER_DIR=http://www.bonzaiengine.com/applet/shader-demo


4) Building

Double click on 'script/deploy.bat' and check for errors.
The gallery is now ready in 'script/applet/'.


5) Upload online

Copy all files from 'script/applet/' to SERVER_DIR.


============
TROUBLESHOOT
============

If you need any help, support of this tool is available in
the official forum at: http://www.bonzaiengine.com/?forum=26
and by email at: support@bonzaiengine.com
