|
| 1 | +# Quickstart extras |
| 2 | + |
| 3 | +The following sections contain additional options and details for installing and running a packaged version of the CARLA simulator. |
| 4 | + |
| 5 | +* __[Command-line options](#command-line-options)__ |
| 6 | +* __[Config script](#config-script)__ |
| 7 | +* __[Import additional assets](#import-additional-assets)__ |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Command-line options |
| 12 | + |
| 13 | +There are some configuration options available when launching CARLA and they can be used as follows: |
| 14 | + |
| 15 | +```sh |
| 16 | + ./CarlaUE4.sh -carla-rpc-port=3000 |
| 17 | +``` |
| 18 | + |
| 19 | +* `--ros2` - Launch CARLA with the native ROS2 connector enabled |
| 20 | +* `-carla-rpc-port=N` - Listen for client connections at port `N`. Streaming port is set to `N+1` by default. |
| 21 | +* `-carla-streaming-port=N` - Specify the port for sensor data streaming. Use 0 to get a random unused port. The second port will be automatically set to `N+1`. |
| 22 | +* `-quality-level={Low,Epic}` - Change graphics quality level. Find out more in [rendering options](adv_rendering_options.md). |
| 23 | +* __[List of Unreal Engine 4 command-line arguments][ue4clilink].__ - There are a lot of options provided by Unreal Engine however not all of these are available in CARLA. |
| 24 | + |
| 25 | +[ue4clilink]: https://docs.unrealengine.com/en-US/Programming/Basics/CommandLineArguments |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## Config script |
| 30 | + |
| 31 | +The script [`PythonAPI/util/config.py`][config] provides more configuration options and should be run when the server has been started: |
| 32 | + |
| 33 | +[config]: https://github.com/carla-simulator/carla/blob/master/PythonAPI/util/config.py |
| 34 | + |
| 35 | +```sh |
| 36 | +./config.py --no-rendering # Disable rendering |
| 37 | +./config.py --map Town05 # Change map |
| 38 | +./config.py --weather ClearNoon # Change weather |
| 39 | + |
| 40 | +./config.py --help # Check all the available configuration options |
| 41 | +``` |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Import additional assets |
| 46 | + |
| 47 | +Each release has its own additional package of extra assets and maps. These are stored separately to reduce the size of the build, so they can only be imported after the main package has been installed. |
| 48 | + |
| 49 | +__1.__ [Download](https://github.com/carla-simulator/carla/blob/master/Docs/download.md) the appropriate package for your desired version of CARLA. |
| 50 | + |
| 51 | +__2.__ Import the assets: |
| 52 | + |
| 53 | +* __On Linux__: |
| 54 | +Move the compressed archive to the _Import_ folder and run the following script to extract the contents: |
| 55 | + |
| 56 | +```sh |
| 57 | +cd path/to/carla/root |
| 58 | + |
| 59 | +./ImportAssets.sh |
| 60 | +``` |
| 61 | + |
| 62 | +* __On Windows__: |
| 63 | + |
| 64 | + - Extract the contents directly in the root folder. |
| 65 | + |
| 66 | +--- |
0 commit comments