Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config docs about environment variables #39

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions using-openspace/configuration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Configuration

OpenSpace uses a configuration file which is called `openspace.cfg`. This file is located in the OpenSpace folder and includes settings that determine:

- The SGCT configuration (the type of projection and number of windows)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about removing the empty line after each point? makes no difference in the output

Also, Mr @alexanderbock usually wants the list indented one step, so I guess that should be done for this file as well (?)


- The profile set on startup

- The paths where OpenSpace can find files

- The default visibility level for properties

- Configurations for modules

- Fonts and font sizes

- Log and script log outputs

...and a number of other configurations. For complete documentation with regards to the config file, please refer to [this page](#core_configuration).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link does not work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. Did not work in my local build

Feel free to ignore then :)


## Environment Variables

Some of the configurations in the config file can use environment variables. These can be very handy if you use OpenSpace a lot, as they will speed up and/or customize your setup automatically. The environment variables are set as Path variables in a Windows environment. The environment variables are:

- `OPENSPACE_SYNC`: The `sync` folder is where OpenSpace stores all downloaded data, such as models, maps, textures, etc. If this environment variable is set, the `sync` folder (which normally is placed inside the OpenSpace folder) can be placed anywhere on your computer. This is very handy if you are using multiple versions of OpenSpace, for the following reasons:

- If you get a fresh build of OpenSpace you don’t need to download the data again, if you already have the data on disk. This will save you time on startup.

- If you have multiple instances of OpenSpace, the required storage space on your disk will lessen as you only need to store the data once as the `sync` folder can be reused across multiple OpenSpace versions.

- `OPENSPACE_USER`: The `user` folder is meant to be used for all user created files. These include webpanels, bookmarks, recordings, screenshots, data, and configs. If this environment variable is set, the `user` folder which normally is placed inside the OpenSpace folder, can be placed anywhere on your computer. This is very handy if you are using multiple versions of OpenSpace, for the following reasons:

- You can have one "global" folder for all your OpenSpace data, and all your OpenSpace instances will find it.

- It might save you space as you don't have to store data in multiple places.

- `OPENSPACE_GLOBEBROWSING`: If this environment variable is set, the `OpenSpaceData` folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons:

- Faster loading of map tiles that you have already visited.

- Less storage space as all instances of OpenSpace will use the same data.

- `OPENSPACE_LEVEL`: If this environment variable is set, the Property Visibility level will be determined on startup. The property visibility level is a setting that determines how complex the user interface should be. If you select `User`, for example, it means you won't see the more advanced properties that will be visible if you select `AdvancedUser`. The available levels in order of increasing complexity are:

- `NoviceUser`
- `User`
- `AdvancedUser`
- `Developer`
12 changes: 1 addition & 11 deletions using-openspace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,12 @@ authors:
affiliation: American Museum of Natural History
---


# Using OpenSpace

In this chapter, we will delve more deeply into how to use OpenSpace. We will confine our topics here to _using_ the software, and discuss building assets and importing data in [](/creating-data-assets/index).

For this chapter, we need to understand a bit more what goes on under the hood with OpenSpace. So, we kick this chapter off with a bit of an introduction on how data is brought to OpenSpace via profiles, assets, and renderables.



{.glossary .index-list}
[The Building Blocks of OpenSpace](/using-openspace/building-blocks/index)
: How profiles, assets, and renderables work together.
Expand All @@ -29,7 +26,6 @@ For this chapter, we need to understand a bit more what goes on under the hood w
[Actions Panel](/using-openspace/actions-panel/index)
: Automate Scene Adjustments.


:::{toctree}
:maxdepth: 1
:hidden:
Expand All @@ -41,33 +37,27 @@ time-panel/index
actions-panel/index
:::




:::{toctree}
:maxdepth: 1
:caption: Using OpenSpace (Unrenovated)


create-profile/index
skybrowser-panel/index
record-panel/index
geolocation-panel/index
exoplanet-systems-panel/index
keyboard-shortcuts/index


navigation/index
properties/index
configuration/index
scenegraph/index
events/index
scripting/index
users/index
installers/index
builders/index



faq/index

:::