Presentation of Orbiter Scenario Editor
Orbiter Scenario Editor presentation

The Orbiter Scenario Editor is an add-on freeware to manage, create, modify the scenario files of Orbiter, the space flight simulator developped by Doctor Martin Schweiger.

To work, it needs that Orbiter  be already installed.

It is highly recommended to be familiar with the Orbiter satellite parameters to use Orbiter Scenario Editor.

These parameters are described in the Orbiter  User Manual supplied with Orbiter.

Any remark or bug report is welcome and can be mailed to Henri Liné

I would like to express my gratitude and regards to Doctor Martin Schweiger for having developped and released freeware the magnificent space simulator Orbiter.


Principles and features

Orbiter Scenario Editor allows to manage the Orbiter scenario files, by a simple and easy to use windows software presenting all the possible options, instead of manipulating the Orbiter scenario text files.

Working as a non interactive software, Orbiter Scenario Editor only manages the standard parameters and does not take into account the functions customised through the SDK, such as for instance the panels for the ships.

When launched, Orbiter Scenaro Editor, scans the Orbiter configuration files.

This includes not only the standard files installed with Orbiter but also the add-on files that could have been installed besides.

The Orbiter configuration files mainly include the planetary systems (and their planets), the bases (from where the spacecrafts can be launched or where they can be parked), the orbital space stations and the ships (spacecrafts).

Orbiter Scenario Editor manages only the scenario files, which means it does not manages the planet, bases, station and ship own parameters. These parameters do not depend on the scenario itself but on Orbiter configuration files.

Meanwhile, when scanning the Orbiter configuration, Orbiter Scenario Editor checks all planetary systems, stations and ships which can be installed in a scenario, including the add-on files.

Orbiter Scenario Editor therefore allows to integrate any of these data to a scenario file, and customise it up to the user wishes.


Open a file

To open a scenario file, select the option Open from the menu File.

The following dialog box appears to present the list of all the scenario files installed in Orbiter.

Select the scenario folder or sub folder.

Click on a file on a list to display the corresponding description.

To load and open a file, click on the button Load, once a file has been selected.


Save a file

To save a scenario file, select the option Save from the menu File.

The scenario file is then saved under the same name, as configured with Orbiter Scenario Editor.

There must be at least one ship set in the scenario.

WARNING : before saving, check that all the scenario parameters are correct or coherent, or that no parameter misses to avoid any fancy behaviours of the scenario with Orbiter.


Save a file under another name

To save a scenario file under another name, select the option Save as from the menu File.

The following dialog box appears presenting the list of all the scenario files installed in Orbiter, and a text box for thebearing the scenario name to be saved.

Select the scenario folder or sub folder.

Click on the scenario list allows to insert the selected file in the text box, to be modified or not.

Click on the button Save as to save the scenario under the name in the texte box.

If this name was already used, a confirmation would be requested.

There must be at least one ship set in the scenario.

WARNING : before saving, check that all the scenario parameters are correct or coherent, or that no parameter misses to avoid any fancy behavious of the scenario with Orbiter.


Delete a scenario file

To delete a scenario file, select the option Delete a scenario from the menu File.

The following dialog box appears to present the list of all the scenario files installed in Orbiter.

Select the scenario folder or sub folder.

Click on a file on a list to display the corresponding description.

To delete the selected file, click on the button Delete. A confirmation is requested to validate the deleting.

Nota : both (Current state) and (Quicksave state) scenarios may not be deleted, letting at least that 2 scenario files remaining within the Orbiter configuration.


Présentation
Introduction

Orbiter Scenario Editor manages only the scenario files installed in the Orbiter scenario folder.

Orbiter Scenario Editor does not allows to create directly a "New scenario", for it is easier to modify an existing scenario than to start from nothing, due to the complexity of the numerous orbital parameters, and that 2 scenario files (Current state) and (Quicksave state) exist at least within Orbiter.

Nota : a scenario can be totally reset by cliking on its plenetary system combo box.

So that, to create a brand new scenario, an easy way is to load a scenario and totally reset it by clicking on the planetary system combo box, and them rename it by saving it under another name..

A scenario can be saved only if it contains at least one ship.


Description
Introduction

This tab allows to modify the scenario general data of the scenario, which are the scenario description, the planetary system, the user controlled spacecraft

When selected, the following tab appears :


Scenario description

This function is available in the Description, environment and focus tab.

The scenario description can be modifed simply by entering new text in the corresponding text box.

No confirmation is required to valid the text.


Focus

This function is available in the Description, environment and focus tab.

The focus allows to select the planetary system and the user controlled spacecraft.

WARNING : if the the planetary system is changed, it resets all the data and loads all the new planetary system planet configuration (for instance, the orbital stations orbiting around some planets are no longer be presented for the planets they would orbit around could no longer exist in the new planetary system).

To avoid any mistake, the changing of planetary system is protected by a check box which triggers its permission to be enable.

The user controlled spacecraft can be choosen from the possible ship list. This list presents only the ships which are integrated in the scenario. To update this list, go the the Ship list tab the manage the ships integrated in the scenario.

To change the user controlled spacecraft, select a ship from the possible ship list, and click on the button "Change user-controlled ship".


Scenario start time

This function is available in the Description, environment and focus tab.

The scenario starting time can be easily set by selecting the desired date and time by simply clicking on the calendar.

Orbiter Scenario Editor manages only the date, the hour and the minutes.

That means the seconds are not managed and therefore the time accuracy is on one minute.

This can involve a very light non significative difference between the previous and final time parameter figures for a scenario time loaded and then saved by Orbiter Scenario Editor.

As soon as the calendar is clicked, the values are taken into account and no confirmation is then required


Station tab
Orbital station tab presentation

This tab allows to modify the list and parameters of the stations integrated in the scenario.

The parameters are presented for updating as following :

To help in this task, Orbiter Scenario Editor presents to the user choice, all the stations which exist in Orbiter configuration, including the add-on ones and the stations no already installed in the scenario file.


Station parameters

This function is available in the Orbital station list tab.

All the station parameters to be taken into account by the Orbiter scenario files are presented in this tab.

The values displayed in red are the ones available even if not integrated in the scenario file.

It is possible to modify all the parameters.

The definitions of these parameters are described in the Orbiter User Manual.

It is possible to add, delete modify a station.

The station name can be modified.

Meanwhile, the modifications are taken into account only after validation by the button "Station parameter validation", otherwise the new values might be lost, specially by selecting another station.


Station actions
Actions

This function is available in the Orbital station list tab.

3 actions are possible in this tab :

- station parameter validation

- add a new station

- delete a station

Click on the button "Station parameter validation" validates all the data displayed for the selected station.

Before validating the parameters, Orbiter Scenario Editor verifies the values.

If the values are accepatable, they are registered as the station new parameters.

If some of the values are not accepted, the following dialog box appears, displaying the list of the parameters presenting incorrect values :

Unlike the ships, it supposes that every station orbits around a planet, and therefore has an eliptic (or circular) trajectory. It involves thus that the station excentricity is inferior to 1.

It also involves that the station orbit does not cross nor the planet atmosphere neither the planet surface.

Click on the button "Add a new station" adds a new station. The station parameters are blank and it will be necessary to enter some correct values.

Click on the button "Delete station" withdraw the station from the scenario file (the station configuration file is not deleted). A confirmation is requested before deleting.*

Nota : in case of ship(s) docked at a station and that the planet is changed, the ship(s) will remain docked at the station orbiting around the new planet; the ship parameters are updated when validating the station parameters.


Ship tab
Ship tab presentation

This tab allows to modify the list and parametesr of the ships integrated in the scenario

The parameters are presented for updating as following :

To help in this task, Orbiter Scenario Editor presents to the user choice, all the ships which are installed in the Orbiter configuration, including the add-on ones and the stations not already installed in the scenario file.


Ship parameters

This function is available in the Ship list tab.

The standard ship parameters to be taken into account by the Orbiter scenario files are presented in this tab.

The values appearing in red are the ones available even if not already integrated in the scenario file.

It is possible to modify all the parameters.

The definitions of these parameters are described in the Orbiter User Manual.

It is possible to add, delete modify a ship.

The station name can be modified.

Meanwhile, the modifications are taken into account only after validation by the button "Ship parameter validation", otherwise the new values might be lost, specially by selecting another station.

There are 3 status for a ship :

- Landed

- Docked

- Orbiting

For Docked and Landed status, a treeview appears to eventually select or modify the station dock or landing pad where the ship is parked.

These treeviews display the planet (and their moons), and the stations and docks integrated in the scenario file, or the planet bases integrated in the planet configuration files.

These objects are represented in the treeviews by the following symbols :

 for a planet

 for a moon

 for a station (orbiting around a planet or on a moon)

 for a station dock

 for a base (located on a planet or on a moon)

 for a base pad

 for a ship

To select a new station dock or a new base pad for a parked ship, simply double click either on the wished station dock number or the wished base pad number.

In the treeviews, the planets, moons, bases, base pads, orbital stations, orbital station docks and ships are displayed in their natural order.

Nota : only the ships docked at a station dock or parked at a base pad are displayed; ships orbiting around planets are not displayed.


Ship management
Actions

This function is available in the Ship list tab.

3 actions are possible in this tab :

- ship parameter validation

- add a nex ship

- delete a ship

Click on the button "Ship parameter validation" validates all the data displayed for the selected ship.

Before validating the parameters, Orbiter Scenario Editor verifies the values.

If the values are acceptable, they are registered as the ship new parameters.

If some of the values are not accepted, the following dialog box appears, displaying the list of the parameters presenting incorrect values :

Click on the button "Add a new ship" adds a new station. The ship parameters are blank and it will be necessary to enter some correct values.

Click on the button "Delete ship" withdraw the ship from the scenario file (the ship configuration file is not deleted). A confirmation is requested before deleting.

Nota : it is recommended to check the ship fuel level value before validating to avoid a value equal to 0 which would involve no possibility to use any ship engine when running the scenario under Orbiter.


Disclaimer

Orbiter Scenario Editor is provided "as is" without warranty of any kind. The entire risk as to the results and the performance of the software is assumed by the user, and in no event will Henri Liné be liable for any consequential, incidental or direct damages suffered in the course of using the software in this archive.

All express, implied and statutory warranties, including, without limitation, the warranties of fitness for a particular purpose, and non-infringement of proprietary rights , are expressly disclaimed to the fullest extent permitted by law.

Limitation of liability under no circumstances shall Henri Liné be liable to any user on account of that user's use. Such limitation of liability shall apply to prevent recovery of direct, indirect, incidental, consequential, special and exemplary damages (even if Henri Liné has been advised of the possibility of such damages), arising from any use  (including such damages incurred by third parties.


Copyright

Orbiter Scenario Editor is a free software in the sense that you are free to download, copy and redistribute it, provided that the copyright notice remains in the copy. You are not allowed to charge a fee for the software without the consent of the author other than to cover the cost of the distribution. If a fee is charged it must be made clear to the purchaser that the sofware is freeware and that the fee is to cover the distributor's cost of providing the software.

You are not allowed to modify any executable files or documentation in any way.

With thanks

The installation pack was made with the freeware Qsetup from Pantaray Software Systems.

Information on this software can be found at http://www.panta-ray.com

The help file has been developped with the freeware Help Creator version 1.0.0.36 form Breit Technologies.

Information on this software can be found at http://www.breittechnologies.com


Error Log

When Orbiter Scenario Editor opens a scenario file, it scans several file to extract the information relative to the scenario and the various objects installed or available in Orbiter configuration, such as the planets, the orbital stations and the ships.

If be mistake some configuration information or files were missing (e.g. add-on files only partially installed), the scanning by Orbiter Scenario Editor would be incomplete or would generate file opening poblems.

In order to asssit the Orbiter Scenario Editor user in such case, Orbiter Scenario Editor logs the files which it could not handle properly.

This function can be called by selecting Tools and then Error Log in the bar menu.

The following dialog box then appears :


Installation

Orbiter Scenario Editor v1.08 can be installed in any folder.

Meanwhile, once installed, Orbiter Scenario Editor needs to know where to find and locate the configuration and scenario information.

These data are indicated in the Orbiter configuration file "orbiter.cfg", which is installed in the same folder as Orbiter itself.

The Orbiter folder location must therefore be set up in the Orbiter Scenario Editor configuration.

In this purpose, at the first launch (unless Orbiter Scenario Editor is installed in the same folder as Orbiter, and therefore finds immediately the file orbiter.cfg), the following dialod box appears to search where Orbiter Scenario Editor will henceforth locate the Orbiter data :

The button Validate is not enabled unless the correct folder is selected.

Navigate through the file list until the right folder is displayed and select it by double clicking.

Once selected, the button Validate is enabled, and validate the folder by clickin on the button Validate.

Orbiter Scenario Editor v1.03 can then extract all the necessary data to be able to work, and starts.


Tool presentation

Some funtions are provided directly from Orbiter Scenario Designer to facilitate the task of the

scenario designer.

These functions are the following :

- Error Log

- Orbiter folder search

- Planetary system information

- Spherical cartesian calculator

- Windows calculator

They can be called from the bar menu, by selecting Tools.


Planetary system information

This function can be called by selecting Tools and then Planetary system information in the bar menu.

When setting a station or a ship orbit, some information may be necessary to ensure that the figures fit with the planet characteristics.

It is possible to displa the main charateristics (mass, mean radius, atmosphere altitude limit and sideral rotation period) of the planets part of the planetary system selected for the scenario.

The following dialog box is then displayed :

Any planet of the planetary system can be selected and its characteristics displayed.


Windows calculator

This function can be called by selecting Tools and then Planetary system information in the bar menu.

When designing a scenario, some calculations can be necessary.

In this aim, it is possible to call the standard calculator supplied with Microsoft Windows.

The Windows calculator is then launched under the condition it was actually installed in the Windows configuration.


Orbiter folder search

This function can be called by selecting Tools and then Orbiter folder search in the bar menu.

Orbiter Scenario Editor can start only if the Orbiter folder has been located.

It is however possible to set Orbiter Scenario Editor to another Orbiter folder.

This might be useful in case of several Orbiter version are installed on a same PC.

The following dialog box appears :

The button Validate is not enabled unless the correct folder is selected.

Navigate throught the file list until the right folder is displayed and select it by double clicking.

Once selected, the button Validate is enabled, and validate the folder by clickin on the button Validate.

Once a new folder is selected and validated, it is taken into account at the next starting of Orbiter Scenario Editor.

Before this starting, Orbiter Scenario Editor continues to use the former folder.

So that, it is necessarèy to close and restart Orbiter Scenario Editor to let Orbiter Scenario Editor use the new selected folder.


Thanks
Credits

The help file has been developped with Help Creator from Breit Technologies

The installation setup has been developped with Qsetup Composer from Breit Technologies


Scenario folder management

From Orbiter Build 021202, it is possible to use scenario files located not only in the Orbiter scenario folder but also in any of its subfolder.

This feature was introduce in order to sort and easlily find the scenarios.

A description can also be assigned to the scenario folders/subfolder can also be described

The Scenario folder function allows to create, delete, scenario subfolders and create or modify their descriptions.

To call this function, select the option Scenario folder management from the menu File.

The following windows appears.

It is then easily possible to browse the folders, and insert or delete a folder thkns to the command buttons, or to modify the scenario description simply adjusting the desription text and then saving it by clicking on the command button "Save folder description".


Coordinate converter
Spherical cartesian converter

This function can be called by selecting Tools and then Sperical cartesian converter in the bar menu.

The following windows appears :

It allows to convert 3D vector in cartesian coordinates.

This feature can be convenient, for example, in case of a speed calculation, giving a speed value and direction, which hans then to be projected to the 3 axis X, Y, Z to get the parameter to be set in the scenario.

The parameter definitions are indicated in the following drawing :

Rho is the radius

Theta is the azimuth

Phi is the elevation