-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Overhaul of quickstart documentation #9128
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Quickstart extras | ||
|
||
The following sections contain additional options and details for installing and running a packaged version of the CARLA simulator. | ||
|
||
* __[Command-line options](#command-line-options)__ | ||
* __[Config script](#config-script)__ | ||
* __[Import additional assets](#import-additional-assets)__ | ||
|
||
--- | ||
|
||
## Command-line options | ||
|
||
There are some configuration options available when launching CARLA and they can be used as follows: | ||
|
||
```sh | ||
./CarlaUE4.sh -carla-rpc-port=3000 | ||
``` | ||
|
||
* `--ros2` - Launch CARLA with the native ROS2 connector enabled | ||
* `-carla-rpc-port=N` - Listen for client connections at port `N`. Streaming port is set to `N+1` by default. | ||
* `-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`. | ||
* `-quality-level={Low,Epic}` - Change graphics quality level. Find out more in [rendering options](adv_rendering_options.md). | ||
* __[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. | ||
|
||
[ue4clilink]: https://docs.unrealengine.com/en-US/Programming/Basics/CommandLineArguments | ||
|
||
--- | ||
|
||
## Config script | ||
|
||
The script [`PythonAPI/util/config.py`][config] provides more configuration options and should be run when the server has been started: | ||
|
||
[config]: https://github.com/carla-simulator/carla/blob/master/PythonAPI/util/config.py | ||
|
||
```sh | ||
./config.py --no-rendering # Disable rendering | ||
./config.py --map Town05 # Change map | ||
./config.py --weather ClearNoon # Change weather | ||
|
||
./config.py --help # Check all the available configuration options | ||
``` | ||
|
||
--- | ||
|
||
## Import additional assets | ||
|
||
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. | ||
|
||
__1.__ [Download](https://github.com/carla-simulator/carla/blob/master/Docs/download.md) the appropriate package for your desired version of CARLA. | ||
|
||
__2.__ Import the assets: | ||
|
||
* __On Linux__: | ||
Move the compressed archive to the _Import_ folder and run the following script to extract the contents: | ||
|
||
```sh | ||
cd path/to/carla/root | ||
|
||
./ImportAssets.sh | ||
``` | ||
|
||
* __On Windows__: | ||
|
||
- Extract the contents directly in the root folder. | ||
|
||
--- |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.