mv upstream READMEs
parent
804a5de2a7
commit
9b561aa551
|
@ -0,0 +1,309 @@
|
|||
***************************************************************************
|
||||
* Celestia *
|
||||
* *
|
||||
* A real-time space simulation that lets you experience our universe in *
|
||||
* three dimensions. *
|
||||
* *
|
||||
* Copyright (c) 2001-2021, Celestia Development Team *
|
||||
* *
|
||||
*-------------------------------------------------------------------------*
|
||||
* Celestia web site: https://celestia.space/ *
|
||||
* *
|
||||
* Celestia documentation: *
|
||||
* https://celestia.space/guides.html *
|
||||
* Celestia WikiBook: https://en.wikibooks.org/wiki/Celestia *
|
||||
* *
|
||||
* Celestia forums: https://celestia.space/forum/ *
|
||||
* *
|
||||
***************************************************************************
|
||||
|
||||
CONTENTS
|
||||
--------
|
||||
License
|
||||
Getting Started
|
||||
Mouse, Keyboard & Joystick Controls
|
||||
Star & Solar System Browser
|
||||
Selecting Objects by Name
|
||||
Known Issues
|
||||
User Modifiable Elements
|
||||
Celestia Resources
|
||||
Building From Sources
|
||||
Contributions
|
||||
Acknowledgements
|
||||
|
||||
|
||||
LICENSE
|
||||
-------
|
||||
This program is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License as published by the Free Software
|
||||
Foundation; either version 2 of the License, or (at your option) any later
|
||||
version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
details, which you should have received along with this program (filename:
|
||||
COPYING). If not, request a copy from:
|
||||
Free Software Foundation, Inc.
|
||||
59 Temple Place - Suite 330
|
||||
Boston, MA 02111-1307
|
||||
USA
|
||||
|
||||
|
||||
GETTING STARTED
|
||||
---------------
|
||||
Celestia will start up in a window, and if everything is working correctly,
|
||||
you'll see Earth in front of a field of stars. Displayed on-screen, is some
|
||||
information about your target (Earth), your speed, and the current time
|
||||
(Universal Time, so it'll probably be a few hours off from your computer's
|
||||
clock).
|
||||
|
||||
Right drag the mouse to orbit Earth and you might see the Moon and some
|
||||
familiar constellations. Left dragging the mouse changes your orientation
|
||||
also, but the camera rotates about its center instead of rotating around
|
||||
Earth. Rolling the mouse wheel will change your distance to Earth--you can
|
||||
move light years away, then roll the wheel in the opposite direction to get
|
||||
back to your starting location. If your mouse lacks a wheel, you can use the
|
||||
Home and End keys instead.
|
||||
|
||||
When running Celestia, you will usually have some object selected. Currently,
|
||||
it's Earth, but it could also be a star, moon, spacecraft, galaxy, or some
|
||||
other object. The simplest way to select an object is to click on it. Try
|
||||
clicking on a star to select it. The information about Earth is replaced with
|
||||
some details about the star. Press G (or use the Navigation menu), and you'll
|
||||
zoom through space toward the selected star. If you press G again, you'll
|
||||
approach the star even closer.
|
||||
|
||||
Press H to select our Sun, and then G to go back to our Sun. Right click on
|
||||
the sun to bring up a menu of planets and other objects in the solar system.
|
||||
After selecting a planet from the menu, hit G again to travel toward it. Once
|
||||
there, hold down the right mouse button and drag to orbit the planet.
|
||||
|
||||
The Tour Guide is a list of some of the more interesting objects you can visit
|
||||
in Celestia. Select the Tour Guide option in the Navigation menu to display
|
||||
the Tour Guide window. Choose a destination from the list, click the Goto
|
||||
button, and you're off.
|
||||
|
||||
That covers the very basics. For a more in-depth look at Celestia and the
|
||||
controls available to you, download the "Celestia User's Guide" (written by
|
||||
Frank Gregorio), available in several languages, from:
|
||||
https://celestia.space/guides.html
|
||||
This web page also includes links to the Celestia README file translated into
|
||||
Japanese.
|
||||
|
||||
|
||||
MOUSE, KEYBOARD & JOYSTICK CONTROLS
|
||||
-----------------------------------
|
||||
See the included file: controls.txt OR use the Help menu to display the Controls
|
||||
list.
|
||||
|
||||
|
||||
STAR & SOLAR SYSTEM BROWSER
|
||||
-------------------------------------------
|
||||
The Navigation menu contains 'Solar System Browser' and 'Star Browser'
|
||||
options.
|
||||
|
||||
STAR BROWSER
|
||||
|
||||
By default, the Star Browser window displays a table of the 100 nearest stars,
|
||||
along with their Distance, Apparent and Absolute Magnitude, and Type. Clicking
|
||||
on the column headers will sort the stars. The table is not continuously
|
||||
updated, so if you travel to another star, you should press the Refresh button
|
||||
to update the table for your current position. The radio buttons beneath the
|
||||
table let you switch between viewing a list of Nearest, Brightest, or 'With
|
||||
planets' stars. As with the solar system browser, clicking on any star name
|
||||
in the table will select it. Use this feature along with the Center and Go
|
||||
To buttons to tour the stars visible from any night sky in the galaxy.
|
||||
|
||||
SOLAR SYSTEM BROWSER
|
||||
|
||||
The Solar System Browser displays a window with a tree view of all the objects
|
||||
in the nearest solar system (if there is one within a light year of your current
|
||||
position.) Clicking on the name of any object in the window will select it.
|
||||
You can then use the Center or Go To buttons to display that object in the main
|
||||
Celestia window.
|
||||
|
||||
|
||||
SELECTING OBJECTS BY NAME
|
||||
-------------------------
|
||||
Celestia provides several ways to select an object by name...
|
||||
1. Choose 'Select Object' from the Navigation menu, type in the object
|
||||
name, and click OK.
|
||||
|
||||
2. Press Enter, type in the entire object name, and press Enter again.
|
||||
|
||||
3. Press Enter, type in the first few characters of the object name,
|
||||
press the Tab key to move through the displayed listing until the
|
||||
object is highlighted, then press Enter again.
|
||||
|
||||
You can use common names, Bayer designations or catalog numbers for stars.
|
||||
Celestia currently supports the HIP, HD and SAO catalogs. Catalog numbers must
|
||||
be entered with a space between the prefix and the catalog number.
|
||||
|
||||
|
||||
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:
|
||||
https://celestia.space/forum/
|
||||
|
||||
|
||||
USER MODIFIABLE ELEMENTS
|
||||
------------------------
|
||||
You can modify how Celestia starts up each time you run it, by defining your
|
||||
own start-up settings. Simply open the file "start.cel" in a plain text
|
||||
editor and follow the in-file instructions. Also, view the celestia.cfg file
|
||||
in a plain text editor to see additional settings.
|
||||
|
||||
Celestia allows you to easily add real, hypothetical, or fictional objects
|
||||
by creating new catalog files. It is *not* recommended that you alter the
|
||||
built-in data files; nearly all desired modifications and additions can be
|
||||
made by placing new catalog files in Celestia's extras folders. There are three
|
||||
types of catalog files:
|
||||
- ssc (solar system catalog: planets, moons, spacecraft, etc.)
|
||||
- stc (star catalog)
|
||||
- dsc (deep sky catalog: galaxies, star clusters, and nebulae)
|
||||
All three types of catalog file are text files that can be updated with your
|
||||
favorite text editing program.
|
||||
|
||||
|
||||
CELESTIA RESOURCES
|
||||
------------------
|
||||
Celestia Web Site:
|
||||
https://celestia.space/
|
||||
|
||||
Celestia User Forums:
|
||||
https://celestia.space/forum/
|
||||
|
||||
Selden's List of Resources for Celestia:
|
||||
https://www.classe.cornell.edu/~seb/celestia/
|
||||
|
||||
Celestia Wikibook:
|
||||
https://en.wikibooks.org/wiki/Celestia
|
||||
|
||||
Celestial Matters Website and Forums:
|
||||
http://www.celestialmatters.org/
|
||||
http://forum.celestialmatters.org/
|
||||
|
||||
Celestia Motherlode:
|
||||
http://www.celestiamotherlode.net/
|
||||
|
||||
Celestia Source Repository:
|
||||
https://github.com/CelestiaProject/Celestia
|
||||
|
||||
Celestia Bug Tracking:
|
||||
https://github.com/CelestiaProject/Celestia/issues
|
||||
|
||||
Celestia Feature Requests:
|
||||
https://github.com/CelestiaProject/Celestia/issues
|
||||
|
||||
Celestia Discord Server:
|
||||
https://discordapp.com/invite/WEWDcJh
|
||||
|
||||
Celestia Subreddit:
|
||||
https://www.reddit.com/r/Celestiasoftware/
|
||||
|
||||
Celestia Archive Repository:
|
||||
https://github.com/Anthony-B-Russo10/Celestia-Archive
|
||||
|
||||
BUILDING FROM SOURCES
|
||||
---------------------
|
||||
See file INSTALL for building instructions.
|
||||
|
||||
|
||||
CONTRIBUTIONS
|
||||
-------------
|
||||
|
||||
Authors
|
||||
-------
|
||||
Chris Laurel <claurel@gmail.com>
|
||||
Clint Weisbrod <cweisbrod@cogeco.ca>
|
||||
Fridger Schrempp <t00fri@mail.desy.de>
|
||||
Bob Ippolito <bob@redivi.com>
|
||||
Christophe Teyssier <chris@teyssier.org>
|
||||
Hank Ramsey <hramsey@users.sourceforge.net>
|
||||
Grant Hutchison <grant.celestia@xemaps.com>
|
||||
Pat Suwalski <pat@suwalski.net>
|
||||
Toti
|
||||
Da Woon Jung <dirkpitt2050@users.sf.net>
|
||||
Vincent Giangiulio <vince.gian@free.fr>
|
||||
Andrew Tribick
|
||||
Hleb Valoshka
|
||||
Li Linfeng
|
||||
|
||||
Contributors
|
||||
------------
|
||||
Deon Ramsey ........... Original GTK1 interface
|
||||
Christopher Andre ..... Eclipse Finder
|
||||
Colin Walters ......... Endianness fixes
|
||||
Peter Chapman ......... Orbit path rendering changes
|
||||
James Holmes ..........
|
||||
Harald Schmidt ........ Lua scripting enhancements, bug fixes
|
||||
Nils Larsson .......... Qt enhancements
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Frank Gregorio ........ Celestia User's Guide
|
||||
Hitoshi Suzuki ........ Japanese README translation
|
||||
Christophe Teyssier ... DocBook and HTML conversion of User's Guide
|
||||
Diego Rodriguez ....... Acrobat conversion of User's Guide
|
||||
Don Goyette ........... CEL Scripting Guide
|
||||
Harald Schmidt ........ Celx/Lua Scripting Guide
|
||||
|
||||
|
||||
Content
|
||||
-------
|
||||
Please see the README file in the CelestiaContent repository.
|
||||
|
||||
|
||||
Libraries
|
||||
---------
|
||||
|
||||
# This software is based in part on the work of the Independent JPEG Group.
|
||||
|
||||
# Some versions of Celestia may use the SPICE system for spacecraft and
|
||||
planetary information, developed by Caltech/JPL under contract to NASA.
|
||||
|
||||
# Many cylindrical projections of photographs were performed by Fridger
|
||||
Schrempp with Matthew Arcus 'mmps' software,
|
||||
http://www.users.globalnet.co.uk/~arcus/mmps/
|
||||
|
||||
# The lower resolution textures were all converted from their higher resolution
|
||||
versions using Gimp.
|
||||
|
||||
# The star database (stars.dat) was derived from the ESA's HIPPARCOS data set.
|
||||
|
||||
# Constellation boundaries are drawn from Davenhall & Leggett's "Catalogue of
|
||||
Constellation Boundary Data":
|
||||
http://cdsweb.u-strasbg.fr/viz-bin/ftp-index?/ftp/cats/VI/49
|
||||
|
||||
|
||||
Other work
|
||||
----------
|
||||
|
||||
# Selden Ball deserves a special mention for suffering more prerelease versions
|
||||
finding more bugs, and giving more feedback than anyone else.
|
||||
|
||||
# Christophe Campos aka ElChristou created the splash screen for Celestia.
|
||||
|
||||
# The MacOS X icon was designed by Chris Alford: http://www.chrisalford.com/
|
||||
|
||||
# The txf font format used by Celestia was devised by Mark Kilgard.
|
||||
|
||||
|
||||
ACKNOWLEDGEMENTS
|
||||
----------------
|
||||
|
||||
A very big thank you for creating Celestia goes to Chris Laurel who started this
|
||||
program in the year 2001.
|
||||
<claurel@gmail.com>
|
||||
https://celestia.space/
|
||||
|
||||
Special thanks go to all Celestia users who submit bug reports, suggestions, and
|
||||
fixes. Celestia wouldn't be the program it is today, without their help.
|
||||
|
||||
|
||||
|
||||
|
||||
The Celestia Development Team
|
|
@ -0,0 +1,142 @@
|
|||
| **`Release`** | **`Localized`** | **`License`** | **`Contribute`** |
|
||||
|-------------------|---------------|---------------|---------------|
|
||||
|[![GitHub release](https://img.shields.io/github/v/release/CelestiaProject/Celestia?label=Release)](https://celestia.space/download.html) | [![Localization](https://img.shields.io/badge/Localized-85%25-green.svg)](#) | [![License](https://img.shields.io/github/license/CelestiaProject/Celestia?label=License)](https://github.com/CelestiaProject/Celestia/blob/master/COPYING) | [![Contribute](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](#contributing) |
|
||||
|
||||
# Celestia
|
||||
![Celestia](celestia-logo.png)<br>
|
||||
**A real-time space simulation that lets you experience our universe in three dimensions.**
|
||||
|
||||
**Copyright © 2001-2021, Celestia Development Team**<br>
|
||||
**Celestia website: https://celestia.space**<br>
|
||||
**Celestia Wikibook: https://en.wikibooks.org/wiki/Celestia**<br>
|
||||
**Celestia forums: https://celestia.space/forum/**<br>
|
||||
**Celestia Subreddit: https://www.reddit.com/r/Celestiasoftware/**<br>
|
||||
**Celestia Archive Repository: https://github.com/Anthony-B-Russo10/Celestia-Archive**
|
||||
## License
|
||||
|
||||
This program is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License as published by the Free Software Foundation;
|
||||
either version 2 of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details,
|
||||
which you should have received along with this program (filename: COPYING).
|
||||
If not, request a copy from:<br>
|
||||
Free Software Foundation, Inc.<br>
|
||||
59 Temple Place - Suite 330<br>
|
||||
Boston, MA 02111-1307<br>
|
||||
USA
|
||||
|
||||
## Getting started
|
||||
|
||||
Celestia will start up in a window, and if everything is working correctly,
|
||||
you'll see Earth in front of a field of stars. Displayed on-screen, is some
|
||||
information about your target (Earth), your speed, and the current time
|
||||
(Universal Time, so it'll probably be a few hours off from your computer's
|
||||
clock).
|
||||
|
||||
Right drag the mouse to orbit Earth and you might see the Moon and some
|
||||
familiar constellations. Left dragging the mouse changes your orientation
|
||||
also, but the camera rotates about its center instead of rotating around
|
||||
Earth. Rolling the mouse wheel will change your distance to Earth--you can
|
||||
move light years away, then roll the wheel in the opposite direction to get
|
||||
back to your starting location. If your mouse lacks a wheel, you can use the
|
||||
Home and End keys instead.
|
||||
|
||||
When running Celestia, you will usually have some object selected. Currently,
|
||||
it's Earth, but it could also be a star, moon, spacecraft, galaxy, or some
|
||||
other object. The simplest way to select an object is to click on it. Try
|
||||
clicking on a star to select it. The information about Earth is replaced with
|
||||
some details about the star. Press G (or use the Navigation menu), and you'll
|
||||
zoom through space toward the selected star. If you press G again, you'll
|
||||
approach the star even closer.
|
||||
|
||||
Press H to select our Sun, and then G to go back to our Sun. Right click on
|
||||
the sun to bring up a menu of planets and other objects in the solar system.
|
||||
After selecting a planet from the menu, hit G again to travel toward it. Once
|
||||
there, hold down the right mouse button and drag to orbit the planet.
|
||||
|
||||
The Tour Guide is a list of some of the more interesting objects you can visit
|
||||
in Celestia. Select the Tour Guide option in the Navigation menu to display
|
||||
the Tour Guide window. Choose a destination from the list, click the Goto
|
||||
button, and you're off.
|
||||
|
||||
That covers the very basics. For a more in-depth look at Celestia and the
|
||||
controls available to you, download the "Celestia User's Guide" (written by
|
||||
Frank Gregorio), available in several languages, from:<br>
|
||||
https://celestia.space/guides.html<br>
|
||||
This web page also includes links to the Celestia README file translated into
|
||||
Japanese.
|
||||
|
||||
### Star browser
|
||||
By default, the Star Browser window displays a table of the 100 nearest stars,
|
||||
along with their Distance, Apparent and Absolute Magnitude, and Type. Clicking
|
||||
on the column headers will sort the stars. The table is not continuously
|
||||
updated, so if you travel to another star, you should press the Refresh button
|
||||
to update the table for your current position. The radio buttons beneath the
|
||||
table let you switch between viewing a list of Nearest, Brightest, or 'With
|
||||
planets' stars. As with the solar system browser, clicking on any star name
|
||||
in the table will select it. Use this feature along with the Center and Go
|
||||
To buttons to tour the stars visible from any night sky in the galaxy.
|
||||
|
||||
### Solar system browser
|
||||
The Solar System Browser displays a window with a tree view of all the objects
|
||||
in the nearest solar system (if there is one within a light year of your current
|
||||
position.) Clicking on the name of any object in the window will select it.
|
||||
You can then use the Center or Go To buttons to display that object in the main
|
||||
Celestia window.
|
||||
|
||||
### Selecting objects by name
|
||||
Celestia provides several ways to select an object by name...
|
||||
1. Choose 'Select Object' from the Navigation menu, type in the object name, and click OK.
|
||||
2. Press Enter, type in the entire object name, and press Enter again.
|
||||
3. Press Enter, type in the first few characters of the object name,
|
||||
press the Tab key to move through the displayed listing until the object is highlighted,
|
||||
then press Enter again.
|
||||
|
||||
You can use common names, Bayer designations or catalog numbers for stars.
|
||||
Celestia currently supports the HIP, HD and SAO catalogs. Catalog numbers must
|
||||
be entered with a space between the prefix and the catalog number.
|
||||
|
||||
### 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:
|
||||
https://celestia.space/forum/
|
||||
|
||||
### User modifiable elements
|
||||
You can modify how Celestia starts up each time you run it, by defining your
|
||||
own start-up settings. Simply open the file "start.cel" in a plain text
|
||||
editor and follow the in-file instructions. Also, view the celestia.cfg file
|
||||
in a plain text editor to see additional settings.
|
||||
|
||||
Celestia allows you to easily add real, hypothetical, or fictional objects
|
||||
by creating new catalog files. It is *not* recommended that you alter the
|
||||
built-in data files; nearly all desired modifications and additions can be
|
||||
made by placing new catalog files in Celestia's extras folders. There are three
|
||||
types of catalog files:
|
||||
* ssc (solar system catalog: planets, moons, spacecraft, etc.)
|
||||
* stc (star catalog)
|
||||
* dsc (deep sky catalog: galaxies, star clusters, and nebulae)
|
||||
|
||||
All three types of catalog file are text files that can be updated with your
|
||||
favorite text editing program.
|
||||
|
||||
### Building from sources
|
||||
See instructions in file [INSTALL.md](INSTALL.md).
|
||||
|
||||
## Contributions
|
||||
| **`Authors`** | **`Contributors`** | **`Documentation`** | **`Other`** |
|
||||
|-----------------|---------------------|------------------|-------------------|
|
||||
| Chris Laurel, Clint Weisbrod, Fridger Schrempp, Bob Ippolito, Christophe Teyssier, Hank Ramsey, Grant Hutchison, Pat Suwalski, Toti, Da Woon Jung, Vincent Giangiulio, Andrew Tribick, Hleb Valoshka, Łukasz Buczyński, Li Linfeng | Deon Ramsey, Christopher Andre, Colin Walters, Peter Chapman, James Holmes, Harald Schmidt, Nils Larsson, Sergey Leonov, Alexell, Dmitry Brant, Janus | Selden Ball, Frank Gregorio, Hitoshi Suzuki, Christophe Teyssier, Diego Rodriguez, Don Goyette, Harald Schmidt | Creators of scientific database, texture maps, 3D models and used libraries, you can see in full README.|
|
||||
|
||||
### Contributing
|
||||
|
||||
**We welcome feedback, bug reports, and pull requests!**
|
||||
|
||||
For pull requests, please stick to the following guidelines:
|
||||
* Be sure to test your code changes.
|
||||
* Follow the existing code style (e.g., indents).
|
||||
* Put a lot of comments into the code, if necessary.
|
||||
* Separate unrelated changes into multiple pull requests.
|
Loading…
Reference in New Issue