spacecruft
/
CelestiaContent
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README and INSTALL (Closes: #219)

pull/3/head
Hleb Valoshka 2019-01-29 22:27:15 +03:00
parent 44f0e3217e
commit 188c436611
2 changed files with 572 additions and 552 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

185
INSTALL
View File

@ -1,58 +1,58 @@
Basic installation instructions
-------------------------------
Install from you OS repository or from the official bintray repository
https://bintray.com/celestia.
https://bintray.com/celestia/celestia-builds/celestia-dev contains
official development snapshots.
To build from sources please follow instructions below.
Celestia Install instructions for UNIX
--------------------------------------
!!!!! Don't use this file. It's outdated. Use README. !!!!!
!!!!! This file will be updated after switch to CMAKE !!!!!
First you need a C++ compiler able to compile C++11 code (GCC 4.8.1 or later,
Clang 3.3 or later), CMake, GNU Make or Ninja.
You need to have the following components installed before Celestia
will build: OpenGL (tested with Mesa 3.4), glu, libjpeg, and libpng.
Should you have a package based installation (most Linux distributions these
days are), you will also need to install the devel packages for your OpenGL,
glu and glibc packages.
Then you need to have the following devel components installed before Celestia
will build: OpenGL, glu, glew, theora, libjpeg, and libpng. Optional packages
are fmtlib, Eigen3, Qt5, Gtk2 and glut.
For example on modern Debian-derived system you need to install the following
packages: libglew-dev, libjpeg-dev, libpng-dev, libtheora-dev, libgl1-mesa-dev,
libglu1-mesa-dev. Them you may want to install libeigen3-dev, libfmt-dev;
qtbase5-dev, qtbase5-dev-tools and libqt5opengl5-dev if you want to build with
Qt5 interface; libgtk2.0-dev and libgtkglext1-dev to build with legacy Gtk2
interface; or freeglut3-dev to build with glut interface.
OK, assuming you've collected all the necessary libraries, here's
what you need to do to build and run Celestia:
./configure --with-INTERFACE [*]
mkdir build
cd build
cmake .. -DENABLE_INTERFACE=ON [*]
make
make install
sudo make install
[*] INTERFACE must be replaced with one of "kde", "gtk", "gnome", or "glut".
[*] INTERFACE must be replaced with one of "QT", "GTK", or "GLUT".
Four interfaces are available for Celestia:
- glut: minimal interface, barebone Celestia core with no toolbar or menu...
Three interfaces are available for Celestia on Unix-like systems:
- GLUT: minimal interface, barebone Celestia core with no toolbar or menu...
Disabled by default.
- GTK: A full interface with minimal dependencies, adds a menu, a configuration
dialog some other utilities.
- Gnome: The full GTK interface plus a few Gnome integration goodies, such as
preference saving in GConf. This looks and works very much like the
Windows interface.
- KDE3: brings contextual menus, toolbars, KDE integration,
internationalization, bookmarks...
To build the KDE interface (requires various kde-devel packages):
configure --with-kde
To build the Gnome interface (requires gnome-devel and all GTK requirements):
configure --with-gnome
To build the GTK interface (requires gtkglext and gtkglext-devel):
configure --with-gtk
To build the GLUT interface (requires glut and glut-devel):
configure --with-glut
At the end of the configure output shows which interface has been selected, you
should check it is correct before running make.
dialog some other utilities. Legacy interface, may lack some new
features. Disabled by default.
- QT: A full interface with minimal dependencies, adds a menu, a configuration
dialog some other utilities, bookmarks... A preferred option. Enabled by
default, No need to pass -DENABLE_QT=ON.
Starting with version 1.3.1, Lua is the new scripting engine for Celestia,
the old homegrown scripting engine is still available. By default Lua support
will NOT be compiled in, to enable it you need to download the Lua library
from:
http://www.lua.org/
Version 5.0 or newer is required.
Once Lua has been installed on your system, you need to run:
configure --with-lua=/path/to/lua
is enabled, it can be disabled passing -DENABLE_CELX=OFF to cmake.
Versions 5.1, 5.2 or 5.3 of Lua library is required. On Debian-based systems
either one of liblua5.3-dev, liblua5.2-dev or liblua5.1-dev should be installed
to have Lua support.
To check wether your Celestia has been compiled with Lua support, go to File
-> Open. If you have '*.cel *.celx' in the filter box, then Lua is available
@ -66,26 +66,93 @@ need to have the gtk-devel package installed.
Celestia will be installed into /usr/local by default, with data files landing
in /usr/local/share/celestia, but you may specify a new location with the
--prefix option to configure:
configure --prefix=/home/my_directory
All the other usual configure parameters apply; you may see which options
are available using 'configure --help'
If while running configure you see an error reporting that gl.h,
is missing, you either don't have OpenGL installed on your system,
or you don't have the corresponding devel package installed. If for
instance you have Mesa installed, you will also have to install the
mesa-devel package (or something named similarly). Missing glu.h or glut.h
means that you don't have GLU, GLUT, or their devel pacakges installed.
following option to cmake: -DCMAKE_INSTALL_PREFIX=/another/path.
Chris Laurel & Deon Ramsey
claurel@.shatters.net dramsey@users.sourceforge.net
Updated 2003-06-10 by
Christophe Teyssier
chris@teyssier.org
Celestia Install instructions for Windows
-----------------------------------------
Updated 2004-04-28 by pat@suwalski.net
Currently to build on Windows you need a Visual Studio 2015 or later, CMake
and vcpkg (*).
Install required packages:
vcpkg install libpng libjpeg-turbo gettext lua fmt glew eigen3
Install optional packages:
vcpkg install qt5
Configure and build 32-bit version:
md build32
cd build32
cmake -DCMAKE_TOOLCHAIN_FILE=c:/tools/vcpkg/scripts/buildsystems/vcpkg.cmake ..
cmake --build . -- /maxcpucount:N /nologo
Configure and build 64-bit version:
md build64
cd build64
cmake -DCMAKE_GENERATOR_PLATFORM=x64 -DCMAKE_TOOLCHAIN_FILE=c:/tools/vcpkg/scripts/buildsystems/vcpkg.cmake ..
cmake --build . -- /maxcpucount:N /nologo
Instead of N in /maxcpucount pass a number of CPU cores you want to use during
a build.
If you have Qt5 installed using official Qt installer, then pass parameter
CMAKE_PREFIX_PATH to cmake call used to configure Celestia, e.g.
cmake -DCMAKE_PREFIX_PATH=C:\Qt\5.10.1\msvc2015 ..
Not supported yet:
- automatic installation using cmake
- building using GNU toolchain (Mingw32), currently Work-In-Progress
- using Ninja instead of MSBuild
Notes:
* vcpkg installation instructions are located on
https://github.com/Microsoft/vcpkg
Celestia Install instructions for OS X
--------------------------------------
Currently not supported as nobody in the Team has access to an OS X system.
Supported CMake parameters
--------------------------
List of supported parameters (passed as -DPARAMETER=VALUE):
| Parameter | TYPE | Default | Description
+----------------------+------+---------+--------------------------------------
| CMAKE_INSTALL_PREFIX | path | * | Prefix where to install Celestia
| CMAKE_PREFIX_PATH | path | | Additional path to look for libraries
| LEGACY_OPENGL_LIBS | bool | **OFF | Use OpenGL libraries not GLvnd
| ENABLE_CELX | bool | ON | Enable Lua scripting support
| ENABLE_SPICE | bool | OFF | Enable NAIF kernels support
| ENABLE_NLS | bool | ON | Enable interface translation
| ENABLE_GLUT | bool | OFF | Build simple Glut frontend
| ENABLE_GTK | bool | **OFF | Build legacy GTK2 frontend
| ENABLE_QT | bool | ON | Build Qt frontend
| ENABLE_WIN | bool | ***ON | Build Windows native frontend
| ENABLE_THEORA | bool | **ON | Support video capture to OGG Theora
Notes:
* /usr/local on Unix-like systems, c:\Program Files or c:\Program Files (x86)
on Windows depending on OS type (32 or 64 bit) and build configuration.
** Ignored on Windows systems.
*** Ignored on Unix-like systems.
Parameters of type "bool" accept ON or OFF value. Parameters of type "path"
accept any directory.
On Windows systems two additonal options are supported:
- CMAKE_GENERATOR_PLATFORM - can be set to x64 on 64-bit Windows to build
64-bit Celestia. To build 32-bit Celestia it should be omitted.
- CMAKE_TOOLCHAIN_FILE - location of vcpkg.cmake if vcpkg is used.

99
README
View File

@ -1,13 +1,13 @@
***************************************************************************
* Celestia Fork *
* Celestia *
* *
* A real-time space simulation that lets you experience our universe in *
* three dimensions. *
* *
* Copyright (c) 2001-2018, Celestia Development Team *
* Copyright (c) 2001-2019, Celestia Development Team *
* *
*-------------------------------------------------------------------------*
* Celestia web site: http://www.shatters.net/celestia/ *
* Celestia web site: https://celestia.space *
* *
* Celestia documentation: *
* http://celestiamotherlode.net/catalog/documentation.html *
@ -20,7 +20,6 @@
CONTENTS
--------
License
Installing in Unix and Linux
Getting Started
Mouse, Keyboard & Joystick Controls
Star & Solar System Browser
@ -50,35 +49,6 @@ COPYING). If not, request a copy from:
USA
INSTALLING IN UNIX AND LINUX
----------------------------
Currently only QT5 based backend is available. To build it you need QT5
developer libraries.
On Debian based systems the following packages should be installed:
* qtbase5-dev-tools
* qtbase5-dev
* libqt5opengl5-dev
* qtchooser
* libglu1-mesa-dev
* libpng-dev
* libjpeg-dev
* libtheora-dev
* Either one of liblua5.3-dev, liblua5.2-dev or liblua5.1-dev
Optional packages are libeigen3-dev and libglew-dev.
Then do the following actions in Celestia's source directory:
mkdir build && cd build
qmake -qt=5 PREFIX=/opt/celestia -o Makefile ../celestia.pro
make
sudo make install
You can speedup build passing option -jN to make where N is a number of
your CPU cores.
An executable binary will be installed to /opt/celestia/bin/Celestia_QT.
GETTING STARTED
---------------
Celestia will start up in a window, and if everything is working correctly,
@ -175,7 +145,7 @@ KNOWN ISSUES
For up-to-the-minute answers to some common problems encountered when running
Celestia, please view either the FAQ in the Help menu or take a look at the
"Celestia User's FAQ" located on the Celestia User's Forum:
http://www.shatters.net/forum/
https://celestia.space/forum/
USER MODIFIABLE ELEMENTS
@ -200,7 +170,7 @@ favorite text editing program.
CELESTIA RESOURCES
------------------
Celestia Web Site:
https://github.com/CelestiaFork/celestia
https://celestia.space
Celestia User Forums:
https://celestia.space/forum/
@ -218,14 +188,17 @@ Celestial Matters Website and Forums:
Celestia Motherlode:
http://www.celestiamotherlode.net/
Celestia Fork Source Code (SourceForge.net):
https://github.com/CelestiaFork/celestia
Celestia Cource Repository:
https://github.com/CelestiaProject/Celestia
Celestia Binary Repository:
https://bintray.com/celestia
Celestia Bug Tracking (SourceForge.net):
https://github.com/CelestiaFork/celestia/issues
https://github.com/CelestiaProject/celestia/issues
Celestia Feature Requests (SourceForge.net):
https://github.com/CelestiaFork/celestia/issues
https://github.com/CelestiaProject/celestia/issues
CONTRIBUTIONS
@ -276,11 +249,9 @@ Scientific Data Base
# Fridger Schrempp
Complete NGC/IC galaxy database + local group galaxies (galaxies.dsc)
Data base on globular clusters (globulars.dsc)
Data base on visual and spectroscopic binaries (visualbins.stc,
spectbins.stc)
World-capitals.ssc
@ -304,26 +275,20 @@ Texture maps
(though it was converted from Inventor to 3DS format.)
# The Mars, Neptune, and Uranus textures and Mars bump maps are all from James
Hastings-Trew's collection. His maps may be found here:
http://gw.marketingden.com/planets/planets.html
Hastings-Trew's collection.
# Grant Hutchison
Saturn's rings were built by Grant Hutchison from Cassini imaging, with
transparency information derived from stellar transit data obtained from:
http://pds-rings.arc.nasa.gov/ringocc/ringocc.html
Saturn's rings were built by Grant Hutchison from Cassini imaging.
The Eros map is a shaded relief generated from the NEAR laser rangefinder
shape model at:
http://pdssbn.astro.umd.edu/NEARdb/nlr/#shape
The Eros map is a shaded relief generated from the NEAR laser rangefinder.
# Jens Meyer
Dione and Rhea are USGS maps colored and modified by Jens Meyer.
The Moon map is based on data from PDS Map-A-Planet at
http://pdsmaps.wr.usgs.gov/maps.html with colors from Mark Robinson at
http://www.earth.northwestern.edu/research/robinson/MOON/clem_color.html.
The Moon map is based on data from PDS Map-A-Planet at with colors from
Mark Robinson.
# Fridger Schrempp
@ -333,8 +298,7 @@ Texture maps
Titan's cloud texture in natural colors and its surface map at near-infrared
wavelength. They are based on resources available from the imaging site
(Ciclops) of the Cassini mission
(http://ciclops.lpl.arizona.edu/index.php)
(Ciclops) of the Cassini mission http://ciclops.org/
The Phoebe base texture was created from the cylindrical map published by
the Cassini imaging team
@ -348,13 +312,11 @@ Texture maps
The Lunar topography and bump maps, using Clementine laser altimeter data,
merged in the polar regions with topographic data from Clementine 750 nm
oblique and nadir images
(ftp://ftpflag.wr.usgs.gov/dist/pigpen/moon/usgs/topo/global/)
oblique and nadir images.
The Mercury map was created from a combination of Mariner 10 imaging
with recent MESSENGER WAC images from the first two flybys, as collected
and reprojected by Steve Albers:
See http://laps.noaa.gov/albers/sos/sos.html.
and reprojected by Steve Albers.
# Phil Stooke
@ -363,20 +325,17 @@ Texture maps
The Ida and Gaspra photomosaic maps are by Phil Stooke.
# Venus's clouds and the textures for Ganymede, Callisto and Saturn are from
Bj<42>rn J<>nsson. His site at http://www.mmedia.is/~bjj/ is an excellent
resource for solar system rendering.
Björn Jónsson.
# Venus's surface is a copyright-free NASA image, prepared from Magellan radar
data. The original is available at
http://www.solarviews.com/cap/venus/venmap.htm
# The Earth texture was created by NASA using data from the MODIS instrument
aboard the Terra satellite. Further information is available from:
http://earthobservatory.nasa.gov/Newsroom/BlueMarble/
aboard the Terra satellite.
# Steve Albers
The Io and Europa maps are by Steve Albers. His planetary maps are at:
http://laps.noaa.gov/albers/sos/sos.html
The Io and Europa maps are by Steve Albers.
# The textures for the Uranian satellites were created by Ivan Rivera from JPL
data. His Celestia page is: http://bruckner.homelinux.net/celestia.html
@ -419,19 +378,13 @@ Texture maps
# 3D asteroid models of Toutatis, Kleopatra, Geographos, 1998 KY26, Bacchus,
Castalia and Golevka are courtesy of Scott Hudson, Washington State
University. His site is:
http://www.eecs.wsu.edu/~hudson/Research/Asteroids/models.html
University.
# 3D models of Phobos, Deimos, Amalthea, Janus, Epimetheus, Prometheus, Pandora,
Hyperion, Larissa, Proteus, Vesta, Ida, Gaspra and Halley are derived from
Phil Stooke's Cartography of Non-Spherical Worlds at:
http://publish.uwo.ca/~pjstooke/plancart.htm
and optical shape model dataset at:
http://pdssbn.astro.umd.edu/SBNast/holdings/EAR-A-5-DDR-STOOKE-SHAPE-MODELS-
V1.0.html
Phil Stooke's Cartography of Non-Spherical Worlds.
# The 3D model of Eros was prepared from the NEAR laser rangefinder shape model
at: http://pdssbn.astro.umd.edu/NEARdb/nlr/#shape
# The 3D model of Eros was prepared from the NEAR laser rangefinder shape model.
# The Phoebe mesh was designed by Jerry Gardner aka Jestr, jestr@ntlworld.com,
based on Phoebe's bumpy topography display from Cassini,