-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Updates to Linux Build instructions #9171
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
base: ue4-dev
Are you sure you want to change the base?
Conversation
joel-mb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 3 files reviewed, 8 unresolved discussions
Docs/build_linux.md line 50 at r2 (raw file):
sudo apt-add-repository "deb http://archive.ubuntu.com/ubuntu jammy main universe" sudo apt-get update sudo apt-get install build-essential clang-10 lld-10 g++-12 cmake ninja-build libvulkan1 python python3 python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git git-lfs
clang-10, lld-10 and python (i..e, python2) packages are not available in Ubuntu22.04. Actually these packages are not really needed.
CARLA build system does not need clang installed at system level, as it uses the clang provided by the Unreal 4.16 toolchain.
Python2 is also not needed, as we don't support it anymore.
I will test these instructions in a clean environment to verify which packages are really needed.
Docs/build_linux.md line 79 at r2 (raw file):
CARLA_ROOT environment variable
I think we should move this section after the actual CARLA repo has been clone (specifically we can add this comment in the Clone the CARLA repository). No need to add a new section about that.
As far as I've seen, the CARLA_ROOT env variable is not needed until this point.
Docs/build_linux.md line 140 at r2 (raw file):
```sh cd ~ gedit .bashrc # or .profile
Just to start the discussion. Do you think it would be useful to suggest something like this?
echo "export UE4_ROOT=~/UnrealEngine_4.27" >> ~/.bashrcThis command appends the line to the end of .bashrc, so users don’t have to edit it manually.
That said, I’m personally not a big fan of copy-pasting commands that directly modify internal configuration files. Still, I’ve noticed that some other documentation takes this approach.
Docs/build_linux.md line 148 at r2 (raw file):
!!! Note Downloading aria2 with `sudo apt-get install aria2` will speed up the following commands.
Should we add this package in the prerequisites sections. We already have some optional packages there.
Docs/build_linux.md line 160 at r2 (raw file):
You can download the repository as a ZIP archive directly from the [CARLA GitHub repository page](https://github.com/carla-simulator/carla) if you prefer not to use Git. !!! Note
Is this still true. With ue5-dev this may have change?
Docs/build_linux.md line 196 at r2 (raw file):
--- ### Build CARLA with Make
IMHO not needed to add with Make
Docs/build_linux.md line 210 at r2 (raw file):
The Python examples provided with CARLA need some prerequisite libraries installed:
This step should be before the user runs make PythonAPI. Maybe we can add it before this sections.
Docs/build_linux.md line 218 at r2 (raw file):
Building the Python API for a specific Python version
I don’t think the specific details about Python 3.12 and 3.13 are necessary here. However I will test this in a clean environment.
| __2. Using Git__: Using Git, you will establish a git repository for the content in the `${CARLA_ROOT}/Unreal/CarlaUE4/Content/Carla` directory. **This is the preferred method if you intend to commit content updates to CARLA (or your own fork of CARLA)**. From the root directory of the CARLA code repository, run the following command (if you have your own fork of the CARLA content, change the target remote repository accordingly): | ||
|
|
||
| ```sh | ||
| git clone https://bitbucket.org/carla-simulator/carla-content Unreal/CarlaUE4/Content/Carla |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add to the command -b master, to clone master branch in case we switch default branch of bitbucket
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description
Fixes #
Where has this been tested?
Possible Drawbacks
This change is