===========================================================================
XRSound 2.0

Release Date: 4-Apr-2018
  
Copyright 2018 Douglas Beachy; All Rights Reserved.

This software is FREEWARE and may not be sold!

http://www.alteaaerospace.com
mailto:dbeachy@speakeasy.net
    
  Requirements:
    Orbiter 2016 or newer; XRSound will *not* run under older Orbiter versions.
===========================================================================

---------
COPYRIGHT
---------

This software copyright 2018 Douglas Beachy: this software is FREEWARE and may not be sold or distributed for a fee under any circumstances, including a "distribution fee."  You may not redistribute this software or host it on a Web site; however, you are free to link to my Web page at http://www.alteaaerospace.com, and to link with XRSound.lib in own projects and/or create custom XRSound-<vessel class>.cfg files to add any of the included default sounds (and, of course, any new sounds you create) to your own vessels.  However, you may not redistribute any of the default sounds.

You may not charge a fee of any kind to use this software, nor may you use this software for any commercial purpose (i.e., where profit is involved), regardless of the terms governing the Orbiter instance on which it is running, without express written permission signed by the author and sent via hardcopy letter or fax; i.e., an email is not sufficient to grant permission.  Please email me at dbeachy@speakeasy.net if you have any questions.  

This software is provided without any warranty, either expressed or implied.


-------
SUMMARY
-------

XRSound automatically adds default sounds to any Orbiter vessel that defines thrusters.  It includes over 450 default sounds and voice callouts, including all those used by the XR fleet (DeltaGlider-XR1, XR2 Ravenstar, and XR5 Vanguard).  Each sound is fully configurable and may be replaced or disabled by editing $ORBITER_ROOT\XRSound\XRSound.cfg and/or a vessel class's XRSound-<vessel class>.cfg file. 

For information about the XRSound C++ API, refer to $ORBITER_ROOT\Orbitersdk\XRSound.h and $ORBITER_ROOT\Doc\XRSound User Manual.pdf.  Note for developers: the included XRSound.lib is for release builds and XRSoundD.lib is for debug builds.  You need likey need Visual Studio 2015 or newer in order to properly link with XRSound.lib or XRSoundD.lib: older Visual Studio versions have not been tested.

XRSound includes a new ambient music track named `Solar Serenity` that plays in external views in space by default; it was created by and licensed from Grzegorz Lorens ("Loru" on Orbiter-Forum).  If you are interested in a lossless version of Solar Serenity, take a look here: https://loru.bandcamp.com/track/solar-serenity

Please refer to the included $ORBITER_ROOT\Doc\XRSound User Manual.pdf for more information and details about how to install, configure, and use XRSound.

------------------
QUICK INSTALLATION 
------------------

Quick installation instructions are:

    1. Unzip the XRSound.zip installation file to your $ORBITER_ROOT folder; e.g., C:\Orbiter.
    2. Bring up your Orbiter launch pad and click "Modules".
    3. In the "Sound module for Orbiter" section, click on "XRSound" to activate it.
     
You are now ready to launch Orbiter, and you should hear default sounds playing for your active vessel, provided it defines thrusters.  For troubleshooting information and XRSound status info, take a look at the $ORBITER_ROOT\XRSound.log file that is written whenever XRSound runs.

*** Please refer to the included `$ORBITER_ROOT\Doc\XRSound User Manual.pdf` for detailed installation and configuration instructions. ***

Happy orbiting!

-- end --
