Skip to content

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 3 commits into from
Aug 8, 2025
Merged

Conversation

MattRoweEAIF
Copy link
Contributor

@MattRoweEAIF MattRoweEAIF commented Aug 7, 2025

In this pull request, the CARLA quickstart documentation has been overhauled:

  • Made quickstart docs more concise
  • Removed instructions for legacy CARLA versions
  • Removed instructions related to Python 2
  • Moved extra details to second page with links (additional assets, command line options etc.

Additional things included in the pull request:

  • Added correct paths for CARLA logs with default filename to API documentation
  • Changed default name of manual_recording.rec in example scripts to manual_recording.log
  • Added deadsnakes PPA to Python build instructions for Linux.

Description

Fixes #

Where has this been tested?

  • Platform(s): ...
  • Python version(s): ...
  • Unreal Engine version(s): ...

Possible Drawbacks


This change is Reviewable

@MattRoweEAIF MattRoweEAIF requested a review from a team as a code owner August 7, 2025 11:39

Each release has it's own additional package of extra assets and maps. This additional package includes the maps __Town06__ and __Town07__. These are stored separately to reduce the size of the build, so they can only be imported after the main package has been installed.
The package is a compressed file named __CARLA_version.number__. Download and extract the archive in a convenient location (e.g. the `home` or `Documents` directory), then open a command-line terminal inside the top level of the extracted archive.
Copy link
Contributor

Choose a reason for hiding this comment

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

CARLA_version.number

This is confusing to me

./ImportAssets.sh
# For the most recent release
pip3 install carla
#pip3 install carla==0.9.14 <= For a specific version
Copy link
Contributor

Choose a reason for hiding this comment

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

pip3 install carla==0.9.14 <= For a specific version

It'd put this as a comment in the same line

pip3 install carla # or carla==0.9.14 <= For a specific version


[config]: https://github.com/carla-simulator/carla/blob/master/PythonAPI/util/config.py
A new PyGame window will open allowing you to control a vehicle in the CARLA simulator with the arrow keys on the keyboard. When writing your own scripts for CARLA, you should import the CARLA Python API, connect to the server (which needs to be launched first) and access the simulation [`world` Object](python_api.md#carlaworld) with the following code:
Copy link
Contributor

Choose a reason for hiding this comment

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

Pygame, not PyGame

@MattRoweEAIF MattRoweEAIF merged commit c222120 into ue4-dev Aug 8, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants