Chikyu Kuru Kuru (CKK) 1.24

Chikyu Kuru Kuru (CKK)  is an Earth mapping software. It has been developed by Hiroki Ichikawa 
in collaboration with the Dagik Earth project (http://dagik.org).
License condition is described in "CKK_COPYING.txt".

===============================================================
1. Basic Operation

KEYs

"space"-key : Play / Stop animation (Sequential display of images)
"r": Reverse Play / Stop
"+" ("-"): Increase (Decrease) the speed of play

"a": One image forward
"b": One image backward

"s": Spin / Stop spin
">"("<"): Increase (Decrease) the spin speed

"n": Make the north upward

"i": Go to the initial image and initial view-point
"I": Go to the initial image
"J": Go to the last image

"q": Quit

===============================================================
2. Advanced Operation

Arrow keys: Rotation
F1, F2, F3 and F4 keys: Oblique rotation

"A": 10 images forward
"B": 10 images backward

"l"("h") key: Zoom in (out) the Earth
"L"("H") key: Zoom in (out) the Earth, faster

Shift+Mouse drag: Zoom up and out the Earth

"f" key: full screen

 "1" key: Shrink "screen" image
 "2" key: Enlarge "screen" image 
 "3" key: Move "screen" image Left
 "4" key: Move "screen" image Right
 "5" key: Move "screen" image Down
 "6" key: Move "screen" image Up
 
 "o" key: Swith image layers
 "c" key: Caption image show/hide
 "C" key: Icon show/hide
 
Right-Click [only Macintosh]: Display a menu for operation

===============================================================
3. Files
3-1. docs/README.txt (this file)
Description of Chikyu Kuru Kuru (CKK).

3-2. docs/COPYING.txt
License description of CKK

3-3. data/images/map
Standard folder of map files in JPEG format or PPM format. Standard file name of the map is "map_[0-9]*.jpg".
These can be specifed in configuration files, "data/conf/init_conf.txt" and "data/conf/conf.txt" as follows:
#TextureName data/images/map/map_
#TextureSuffix jpg
#TextureStart 0
#TextureEnd 9999

3-4. data/images/screen
Standard folder of caption files in JPEG format or PPM format. Standar file name of the caption is "screen_[0-9]*.jpg".
These can be specifed in configuration files, "data/conf/init_conf.txt" and "data/conf/conf.txt" as follows:
#ScreenName data/images/screen/screen_
#ScreenSuffix jpg

3-5. data/conf
Folder of configuration files, "data/conf/init_conf.txt" and "data/conf/conf.txt".

3-6. data/icons
Folder of icons.

===============================================================
4. Configuration files: "data/conf/init_conf.txt" and "data/conf/conf.txt"
Both files can configure CKK. "conf.txt" overrides "init_conf.txt".
Configuration line starts with single "#", e.g., #Latitude, #Spin, and followed the value.

===================================================
Initial Configuration file for Chikyu Kuru Kuru
	Configuration line starts with single "#", e.g., #Latitude, #Spin.
===================================================
----- Initial view point ------
#Latitude 0.0  :[-90,90]
#Longitude 135.0 :[-180,180]
#Perspective 0:[0: orthogonal, 1: perspective]
#EyePosition 80.0

===================================================
----- Initial setup for animation & spin ------
#Animation 1 :[0: stop, 1: play, -1: reverse play]
#AnimationSpeed 8 :[-30,30]
#StopAt1stMap 1.0
#StopAtFinalMap 1.0
#Repeat 1 

#Spin 0
#SpinSpeed 20 :[-200,200]

===================================================
----- Initial setup for widow size & fullscreen (mac only) ------
#WindowSizeXY 1024 768
#FullScreen 0

===================================================
----- Image file names ------
#TextureName data/images/map/map_
#TextureSuffix jpg
#SecondTextureName data/images/map_second/map_
#SecondTextureSuffix jpg
#ScreenName data/images/screen/screen_
#ScreenSuffix jpg
#TextureName2 data/images_2/map/map_
#TextureSuffix2 jpg
#SecondTextureName2 data/images_2/map_second/map_
#SecondTextureSuffix2 jpg
#ScreenName2 data/images_2/screen/screen_
#ScreenSuffix2 jpg
#TextureStart 0
#TextureEnd 9999
#SecondTexture_at_startup 0

===================================================
----- GUI ------
#InvisibleCursor 0
#NoMouseDragRotation 0

!#Icon 0                                          ### For no Icons
!#Icon 6
!#Icon 13                                        ### Without Fullscreen
!#Icon 14                                       ### No screen control, layers & icon hide
#Icon 23                                       ### Full Icons

#IconScaleXY 0.2 2.4 -1.5		       ###Play/Stop
#Icon2ScaleXY 0.2 1.9 -1.75	        ###Initial
#Icon3ScaleXY 0.2 2.15 -1.5		     ###Reverse Play/Stop
#Icon4ScaleXY 0.2 2.4 1.3		       ###Spin/Stop
#Icon5ScaleXY 0.2 2.4 -1.75		      ###1step Forward
#Icon6ScaleXY 0.2 2.15 -1.75		 ###1step Backward
#Icon7ScaleXY 0.2 2.4 1.05		       ###Latitude/Longitude Lines
#Icon8ScaleXY 0.2 2.4 1.55		       ###Zoom in
#Icon9ScaleXY 0.2 2.15 1.55		      ###Zoom out
#Icon10ScaleXY 0.2 2.15 1.3		      ###North upward
#Icon11ScaleXY 0.2 2.4 -1.25	      ### Fast (Play speed)
#Icon12ScaleXY 0.2 2.15 -1.25	      ### Slow (Play speed)
#Icon13ScaleXY 0.2 2.4 1.95		        ###Quit
#Icon14ScaleXY 0.2 2.15 1.95		  ###Full Screen

#Icon15ScaleXY 0.18 -2.20 1.95		  ###Logo Small
#Icon16ScaleXY 0.18 -1.995 1.95		  ###Logo Large
#Icon17ScaleXY 0.2 -2.65 1.85		  ###Logo Left
#Icon18ScaleXY 0.2 -2.45 1.85		  ###Logo Right
#Icon19ScaleXY 0.2 -2.55  1.65		  ###Logo Down
#Icon20ScaleXY 0.2 -2.55  2.05		  ###Logo Up

#Icon21ScaleXY 0.2 -0.85  -1.75		  ###Switch Layers
#Icon22ScaleXY 0.2 -1.25  -1.75		  ###Screen Show/Hide
#Icon23ScaleXY 0.2 -1.5  -1.75		  ###Icon Show/Hide

--- If don't like to show following icons ---
!#Icon4ScaleXY 0. 12.4 1.3		       ###Spin/Stop
!#Icon7ScaleXY 0. 12.4 1.05		       ###Latitude/Longitude Lines
!#Icon8ScaleXY 0. 12.4 1.55		       ###Zoom in
!#Icon9ScaleXY 0. 12.15 1.55		      ###Zoom out
!#Icon10ScaleXY 0. 12.15 1.3		      ###North upward
#Icon14ScaleXY 0. 12.15 1.95		  ###Full Screen

#Icon15ScaleXY 0. -2.20 1.95		  ###Logo Small
#Icon16ScaleXY 0. -1.995 1.95		  ###Logo Large
#Icon17ScaleXY 0. -2.65 1.85		  ###Logo Left
#Icon18ScaleXY 0. -2.45 1.85		  ###Logo Right
#Icon19ScaleXY 0. -2.55  1.65		  ###Logo Down
#Icon20ScaleXY 0. -2.55  2.05		  ###Logo Up

#Icon21ScaleXY 0. -0.85  -1.75		  ###Switch Layers
!#Icon22ScaleXY 0. -1.25  -1.75		  ###Screen Show/Hide
!#Icon23ScaleXY 0. -1.5  -1.75		  ###Icon Show/Hide
===================================================
----- Size and Locations of Earth, Screen (caption) images and Timebar ------

--- Earth Right, Caption Left ----
#NumberOfEarth 1
#Scale 1.9
#EarthXY 0.3 0.0
#ScreenScaleXY 4.3 -2.6 1.9
#ScreenFront 0 :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
#TimebarScaleXY .2 -1.6 -1.65

--- Earth Left, Caption Right and small----
!#NumberOfEarth 1
!#Scale 1.9
!#EarthXY -0.35 0.0
!#ScreenScaleXY 3.2 1.28 1.5 
!#ScreenFront 0  :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
!#TimebarScaleXY .18 1.5 -1.65

--- Earth Left, Caption on the Earth----
!#NumberOfEarth 1
!#Scale 1.9
!#EarthXY -0.35 0.0
!#ScreenScaleXY 3. -1. 1.
!#ScreenScaleXY 6 -1.3 -1.    : Caption is in lower part.
!#ScreenFront 1  :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
!#TimebarScaleXY .2 -2.5 -1.65
 ---- For No Icon ----
!#Icon 1
!#IconScaleXY  0. -2.1 0.4			       ###Play/Stop

--- Earth Center, Caption on the Earth ----
!#NumberOfEarth 1
!#Scale 1.9
!#EarthXY 0.0 0.0
!#ScreenScaleXY 3. -0.5 1.    : [Caption is center.]
!#ScreenScaleXY 6 -1.3 -1.    : [Caption is in lower part.]
!#ScreenFront 1  :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
!#TimebarScaleXY .2 -2.5 -1.65
 ---- For No Icon ----
!#Icon 1
!#IconScaleXY  0. -2.1 0.4			       ###Play/Stop
 ---- For Icon on bottom ----
!#IconScaleXY 0.2 2.4 -1.25		       ###Play/Stop
!#Icon2ScaleXY 0.2 1.9 -1.75	        ###Initial
!#Icon3ScaleXY 0.2 2.15 -1.25		     ###Reverse Play/Stop
!#Icon4ScaleXY 0.2 1.65 -1.5		       ###Spin/Stop
!#Icon5ScaleXY 0.2 1.9 -1.25		      ###1step Forward
!#Icon6ScaleXY 0.2 1.65 -1.25		 ###1step Backward
!#Icon7ScaleXY 0.2 1.9 -1.5		       ###Latitude/Longitude Lines
!#Icon8ScaleXY 0. 2.4 1.55		       ###Zoom in
!#Icon9ScaleXY 0. 2.15 1.55		      ###Zoom out
!#Icon10ScaleXY 0.2 1.65 -1.75		      ###North upward
!#Icon11ScaleXY 0.2 2.4 -1.5	      ### Fast (Play speed)
!#Icon12ScaleXY 0.2 2.15 -1.5	      ### Slow (Play speed)
!#Icon13ScaleXY 0.2 2.4 -1.75		        ###Quit
!#Icon14ScaleXY 0.2 2.15 -1.75		  ###Full Screen
!#Icon21ScaleXY 0.2 -1.87  -1.75		  ###Switch Layers
!#Icon22ScaleXY 0.2 -2.1  -1.75		  ###Screen Show/Hide
!#Icon23ScaleXY 0.2 -2.6  -1.75		  ###Icon Show/Hide

--- No Earth, Caption Only ----
!#NumberOfEarth 1
!#Scale 0.
!#EarthXY 0.3 0.0
!#NumberOfEarth 1
!#ScreenScaleXY 3.94 -3.12 1.97
!#ScreenFront 0  :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
!#TimebarScaleXY .17 -3.1 -1.75

-------- 2 Windows ---------
--- for 2 Earth - 3D  --
!#NumberOfEarth 2
!#TextureOfEarth2 0
!#EarthRotationSynch 1  ### Rotation Sync
!#EarthSizeSynch 1    ###  Size sync
!#Earth2AngleAxisXY -10 0.0 1.0 ### Angle between two Earths.

--- for 2 Earth - Dual Projector  --
!#NumberOfEarth 2
!#TextureOfEarth2 0
!#EarthRotationSynch 1  ### Rotation Sync
!#EarthSizeSynch 1    ### Size sync
!#Earth2AngleAxisXY -150 0.0 1.0 ### Angle between two Earths.

--- for 2 Earth Normal & Zoom In---
!#NumberOfEarth 2
!#TextureOfEarth2 0
!#EarthRotationSynch 1  ### Rotation Sync
!#EarthSizeSynch 0    ### Size sync
!#Scale2 6.0 ### Scale if size is not sync.
!#Earth2AngleAxisXY 0.0 0.0 1.0  ### Angle between two Earths.

--- for 2 Earth & 2 Textures Sync for 2 parameters ---
!#NumberOfEarth 2
!#TextureOfEarth2 1
!#ScreenScaleXY2 4.3 -2.6 1.9
!#EarthRotationSynch 1  ### Rotation Sync
!#EarthSizeSynch 1    ### Size sync
!#Earth2AngleAxisXY 0.0 0.0 1.0 ### Angle between two Earths.

--- for 2 Earth & 2 Textures No Sync (only Time Sync) for 2 planets/moons  ---
!#NumberOfEarth 2
!#TextureOfEarth2 1
!#EarthRotationSynch 0  ### Rotation Sync
!#Latitude2 0.0  :[-90,90] ### Initial coordinate if rotation is not sync.
!#Longitude2 0.0 :[-180,180] ### Initial coordinate if rotation is not sync.
!#EarthSizeSynch 0    ### Size sync
!#Scale2 1.9 	### Scale if size is not sync.

--- for Earth window and Operation window ---
!#NumberOfEarth 2
!#TextureOfEarth2 1
!#EarthRotationSynch 1  ### Rotation Sync
!#EarthSizeSynch 0    ### Size sync
!#Earth2AngleAxisXY 0.0 0.0 1.0 ### Angle between two Earths.
!#Scale 1.9
!#Scale2 1.9 ### Scale if size is not sync.
!#EarthXY 0.0 0.0
!#ScreenFront 1  :[0:  Caption is behind the Earth. 1: Caption is in front of the Earth.]
!#ScreenScaleXY 4.3 0.0 1.9
!#ScreenScaleXY2 6 -0.9 0.9
!#TextureName data/images/dum/dum_
!#TextureName2 data/images/map/map_
!#TimebarScaleXY 0. -3.1 -1.75
!#Icon 10 
!#IconScaleXY  0.7 -2.1 0.4			       ###Play/Stop
!#Icon2ScaleXY 0.7 -2.55 -0.35	        ###Initial
!#Icon3ScaleXY 0.7 -3. 0.4		     ###Reverse Play/Stop
!#Icon4ScaleXY 0. -3.1 1.7		       ###Spin/Stop
!#Icon5ScaleXY 0. -2.1 0.4		      ###1step Forward
!#Icon6ScaleXY 0. -3. 0.4		 ###1step Backward
!#Icon7ScaleXY 0. 2.4 1.05		       ###Latitude/Longitude Lines
!#Icon8ScaleXY 0. 2.4 1.55		       ###Zoom in
!#Icon9ScaleXY 0. 2.15 1.55		      ###Zoom out
!#Icon10ScaleXY 0.7 -2.55 1.15		      ###North upward

===================================================
----- GRID: Latitude & Longitude lines ------
#MeridianLatitude 0 12 6 3. 5.
#ColorMeridianLatitude 0.7 0.7 0.7 0.7  0.8 0.2 0.2 0.7

===================================================
----- Misc ------
#SpinIntervalSecond 0.01
#InertiaOfRotation 0.02 0.01 0.01 0. : [Start_criteria, Stop_criteria, Speed of rotation, Damping rate (1= little damping, 0 = no inertia rotation)]
===================================================



===============================================================
5. Acknowedgements

Chikyu Kuru Kuru (CKK) uses OpenGL, Freeglut and glut library.
Chikyu Kuru Kuru (CKK) is based in part on the work of the Independent JPEG Group.


===============================================================
  Freeglut Copyright
  ------------------
  
  Freeglut code without an explicit copyright is covered by the following 
  copyright:
  
  Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
  Permission is hereby granted, free of charge,  to any person obtaining a copy 
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction,  including without limitation the rights 
  to use, copy,  modify, merge,  publish, distribute,  sublicense,  and/or sell 
  copies or substantial portions of the Software.
  
  The above  copyright notice  and this permission notice  shall be included in 
  all copies or substantial portions of the Software.
  
  THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS OR 
  IMPLIED,  INCLUDING  BUT  NOT LIMITED  TO THE WARRANTIES  OF MERCHANTABILITY, 
  FITNESS  FOR  A PARTICULAR PURPOSE  AND NONINFRINGEMENT.  IN  NO EVENT  SHALL 
  PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM,  DAMAGES OR OTHER LIABILITY, WHETHER 
  IN  AN ACTION  OF CONTRACT,  TORT OR OTHERWISE,  ARISING FROM,  OUT OF  OR IN 
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  
  Except as contained in this notice,  the name of Pawel W. Olszta shall not be 
  used  in advertising  or otherwise to promote the sale, use or other dealings 
  in this Software without prior written authorization from Pawel W. Olszta.
===============================================================