Skip to content

Commit

Permalink
add linux example to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
madratman committed Jul 24, 2020
1 parent 4b6835c commit c30a24f
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
AirSim is searching for the settings definition in 4 different ways in the following order. The first match will be used:

1. Looking at the (absolute) path specified by the `--settings` command line argument.
Example: `AirSim.exe --settings 'C:\path\to\settings.json'`
2. Looking for a json document passed as a command line argument by the `--settings` argument.
Example: `AirSim.exe --settings '{"foo" : "bar"}'`
3. Looking in the folder of the executable for a file called `settings.json`.
3. Looking in the users home folder for a file called `settings.json`. The AirSim subfolder is located at `Documents\AirSim` on Windows and `~/Documents/AirSim` on Linux systems.
For example, in Windows: `AirSim.exe --settings 'C:\path\to\settings.json'`
In Linux `./Blocks.sh --settings '/home/$USER/path/to/settings.json'`
1. Looking for a json document passed as a command line argument by the `--settings` argument.
For example, in Windows: `AirSim.exe --settings '{"foo" : "bar"}'`
In Linux `./Blocks.sh --settings '{"foo" : "bar"}'`
1. Looking in the folder of the executable for a file called `settings.json`.
2. Looking in the users home folder for a file called `settings.json`. The AirSim subfolder is located at `Documents\AirSim` on Windows and `~/Documents/AirSim` on Linux systems.

The file is in usual [json format](https://en.wikipedia.org/wiki/JSON). On first startup AirSim would create `settings.json` file with no settings at the users home folder. To avoid problems, always use ASCII format to save json file.

Expand Down

0 comments on commit c30a24f

Please sign in to comment.