Updated script to use env variable and docs to reflect how to use it (#7968)

Co-authored-by: Blyron <samaniegoaaron112@ŋmail.com>
This commit is contained in:
Blyron 2024-07-23 08:34:24 +02:00 committed by GitHub
parent f9788a074f
commit c17f02810c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 19 additions and 3 deletions

View File

@ -35,6 +35,15 @@ satisfies_minimum_version() {
set -e
sudo echo "Got super powers..."
echo "Parsing GIT_LOCAL_CREDENTIALS local variable "
arrIN=(${GIT_LOCAL_CREDENTIALS//@/ })
GIT_LOCAL_USER=${arrIN[0]}
GIT_LOCAL_TOKEN=${arrIN[1]}
if [ -z "$GIT_LOCAL_CREDENTIALS" ]
then
echo "Git credentials are not set, they will be requested later on during the download of Unreal Engine Carla fork"
fi
echo "Installing Ubuntu Pacakges..."
if ! command -v retry &> /dev/null
then
@ -103,7 +112,12 @@ else
echo "Found UnrealEngine5 $CARLA_UNREAL_ENGINE_PATH - FAIL"
echo "Cloning CARLA UnrealEngine5..."
pushd ..
git clone -b ue5-dev-carla https://github.com/CarlaUnreal/UnrealEngine.git UnrealEngine5_carla
if [ -z "$GIT_LOCAL_CREDENTIALS" ]
then
git clone -b ue5-dev-carla https://github.com/CarlaUnreal/UnrealEngine.git UnrealEngine5_carla
else
git clone -b ue5-dev-carla https://$GIT_LOCAL_USER:$GIT_LOCAL_TOKEN@github.com/CarlaUnreal/UnrealEngine.git UnrealEngine5_carla
fi
pushd UnrealEngine5_carla
echo -e '\n#CARLA UnrealEngine5\nexport CARLA_UNREAL_ENGINE_PATH='$PWD >> ~/.bashrc
export CARLA_UNREAL_ENGINE_PATH=$PWD

View File

@ -16,11 +16,13 @@ Clone the `ue5-dev` branch of CARLA on your local machine:
git clone -b ue5-dev https://github.com/carla-simulator/carla.git CarlaUE5
```
Run the setup script:
Run the setup script with your GitHub credentials:
> [!NOTE]
> * This version of CARLA requires the **CARLA fork of Unreal Engine 5.3**. You need to link your GitHub account to Epic Games in order to gain permission to clone the UE repository. If you have not already linked your accounts, follow [this guide](https://www.unrealengine.com/en-US/ue4-on-github)
```sh
cd CarlaUE5
bash -x Setup.sh
env GIT_LOCAL_CREDENTIALS=your_user@your_token bash -x Setup.sh
```
The Setup.sh script installs all the required packages, including Cmake, debian packages, Python packages and Unreal Engine 5.3. It also downloads the CARLA content and builds CARLA. This script can therefore take a long time to complete.